Dockerize an Office File API Application

Oct 02, 2024
6 minutes to read

This tutorial describes how to create and dockerize an ASP.NET Core Web API application that uses the Office File API library to convert Excel and Word documents to HTML.

View Example: Dockerize an Office File API Application

Prerequisites

.NET 7.0 SDK
Visual Studio Code
Docker
Thunder Client (a Rest API Client Extension for Visual Studio Code)

Create an Application

Create a folder for your project (DocumentConversionWebApi in this example) and open this folder in Visual Studio Code.
Click View → Terminal in the main menu to open the integrated terminal.
Use the dotnet new command to create a new Web API application.
- CLI
```
dotnet new webapi -o DocumentConversionWebApi
cd DocumentConversionWebApi
```
The image below shows the created project’s structure.

Note
The ASP.NET Core Web API project template contains WeatherForecast API. Delete the files WeatherForecast.cs and Controllers/WeatherForecastController.cs to remove this API from your project.
Install the DevExpress.Document.Processor and DevExpress.Drawing.Skia NuGet packages as described in this help topic: Use NuGet Packages to Install Office File API Components.

Important
You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this package in production code.

Implement an API controller to handle HTTP requests. In the Controllers folder, create a ConvertFileController.cs file with the code below. Implement a PostConvertFile action method to handle HTTP POST requests and to convert uploaded files to HTML.

ConvertFileController.cs

using Microsoft.AspNetCore.Mvc;
using DevExpress.Spreadsheet;
using DevExpress.XtraRichEdit;
using DevExpress.XtraSpreadsheet.Export;

namespace DocumentConversionWebApi.Controllers {
    [Route("[controller]")]
    [ApiController]
    public class ConvertFileController : ControllerBase {
        [HttpPost]
        public async Task<IActionResult> PostConvertFile(IFormFile file) {
            if (file != null) {
                try {
                    using (var stream = new MemoryStream()) {
                        await file.CopyToAsync(stream);
                        stream.Seek(0, SeekOrigin.Begin);
                        switch (Path.GetExtension(file.FileName)) {
                            case ".rtf":
                            case ".doc":
                            case ".docx":
                            case ".txt":
                            case ".mht":
                            case ".odt":
                            case ".xml":
                            case ".epub":
                            case ".html":
                                return new FileStreamResult(ConvertWordDocument(stream), "text/html");
                            case ".xlsx":
                            case ".xlsm":
                            case ".xlsb":
                            case ".xls":
                            case ".xltx":
                            case ".xltm":
                            case ".xlt":
                            case ".csv":
                                return new FileStreamResult(ConvertSpreadsheetDocument(stream), "text/html");
                        }
                    }
                } catch (Exception e) {
                    return StatusCode(500, e.Message + Environment.NewLine + e.StackTrace);
                }
            }
            return new BadRequestResult();
        }

        Stream ConvertWordDocument(Stream inputStream) {
            using (var wordProcessor = new RichEditDocumentServer()) {
                wordProcessor.LoadDocument(inputStream);
                var resultStream = new MemoryStream();
                wordProcessor.Options.Export.Html.EmbedImages = true;
                wordProcessor.SaveDocument(resultStream, DevExpress.XtraRichEdit.DocumentFormat.Html);
                resultStream.Seek(0, SeekOrigin.Begin);
                return resultStream;
            }
        }
        Stream ConvertSpreadsheetDocument(Stream inputStream) {
            using (var workbook = new Workbook()) {
                workbook.LoadDocument(inputStream);
                var resultStream = new MemoryStream();
                var options = new HtmlDocumentExporterOptions();
                options.EmbedImages = true;
                options.AnchorImagesToPage = true;
                workbook.ExportToHtml(resultStream, options);
                resultStream.Seek(0, SeekOrigin.Begin);
                return resultStream;
            }
        }
    }
}

Tip

You can use the AzureCompatibility.Enable property in Docker containers. It allows you to render and print content in environments where the GDI engine is not available.

Create a Dockerfile

Create a Dockerfile within your project folder. This file contains instructions required to build a Docker image and deploy it inside a container. Add the following commands to your Dockerfile:

# Build runtime image
FROM mcr.microsoft.com/dotnet/aspnet:7.0-bullseye-slim AS base
WORKDIR /app
EXPOSE 80
EXPOSE 443

# Install the latest version of font libraries
RUN apt update &&\
         apt install -y libc6 libicu-dev libfontconfig1

# (Optional step) Install the ttf-mscorefonts-installer package
# to use Microsoft TrueType core fonts in the application
RUN echo "deb http://ftp.debian.org/debian/ bullseye contrib" >> /etc/apt/sources.list
RUN apt update
RUN apt install -y ttf-mscorefonts-installer 

FROM mcr.microsoft.com/dotnet/sdk:7.0-bullseye-slim AS build
WORKDIR /src

# Specify your DevExpress NuGet Feed URL as the package source
RUN dotnet nuget add source https://nuget.devexpress.com/{your-feed-authorization-key}/api/v3/index.json
# Copy the project file
COPY ./DocumentConversionWebApi.csproj ./

# Restore as distinct layers
RUN dotnet restore

# Publish a release
RUN dotnet publish "DocumentConversionWebApi.csproj" -c Release -o /app/publish

FROM base AS final
WORKDIR /app
COPY --from=build /app/publish .

# Define the entry point for the application
ENTRYPOINT ["dotnet", "DocumentConversionWebApi.dll"]

# Build runtime image
FROM mcr.microsoft.com/dotnet/aspnet:7.0-jammy AS base
WORKDIR /app
EXPOSE 80
EXPOSE 443

# Install dependencies
RUN apt update
RUN apt install -y libc6 libicu-dev libfontconfig1

# (Optional step) Install the ttf-mscorefonts-installer package 
# to use Microsoft TrueType core fonts in the application
RUN echo ttf-mscorefonts-installer msttcorefonts/accepted-mscorefonts-eula select true | debconf-set-selections
RUN apt install -y ttf-mscorefonts-installer 

FROM mcr.microsoft.com/dotnet/sdk:7.0-jammy AS build
WORKDIR /src

# Copy project files and build the application
COPY . ./

# Specify your DevExpress NuGet Feed URL as the package source
RUN dotnet nuget add source https://nuget.devexpress.com/{your-feed-authorization-key}/api/v3/index.json

# Publish a release
RUN dotnet publish "DocumentConversionWebApi.csproj" -c Release -o /app/publish

FROM base AS final
WORKDIR /app
COPY --from=build /app/publish .

# Define the entry point for the application
ENTRYPOINT ["dotnet", "DocumentConversionWebApi.dll"]

# Build runtime image
FROM mcr.microsoft.com/dotnet/aspnet:7.0-alpine AS base
WORKDIR /app
EXPOSE 80
EXPOSE 443

# Install dependencies
RUN apk update && apk upgrade
RUN apk add icu-libs icu-data-full fontconfig

# (Optional step) Install the ttf-mscorefonts-installer package
# to use Microsoft TrueType core fonts in the application
RUN apk add ttf-dejavu && \
    apk add msttcorefonts-installer && \
    apk add ttf-dejavu && \
    update-ms-fonts && \
    fc-cache -f

ENV DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=false

FROM mcr.microsoft.com/dotnet/sdk:7.0-alpine AS build
WORKDIR /src

# Copy project files and build the application
COPY . ./

# Specify your DevExpress NuGet Feed URL as the package source
RUN dotnet nuget add source https://nuget.devexpress.com/{your-feed-authorization-key}/api/v3/index.json

# Publish a release
RUN dotnet publish "DocumentConversionWebApi.csproj" -c Release -o /app/publish

FROM base AS final
WORKDIR /app
COPY --from=build /app/publish .

# Define the entry point for the application
ENTRYPOINT ["dotnet", "DocumentConversionWebApi.dll"]

Add a .dockerignore file to your project. Exclude the following folders from the build context to increase build performance:

.dockerignore

bin/
obj/

Build and Run the Docker Image

Use the following terminal commands to build and run your Docker image:

console input

docker build -t documentconversionwebapi .
docker run -d -p 8080:80 documentconversionwebapi

Test the Application

This tutorial uses the Thunder Client extension to test the created Web API application.

Install and start Thunder Client in Visual Studio Code. Click New Request to create a new HTTP request to the API endpoint. Select the POST method in the drop-down list and enter the following URL in the input field:

http://localhost:8080/ConvertFile
Specify a Request Body for the POST request. Switch to the Body tab and click Form.
Select the Files check box to display the Files section. Enter file as the field name and click Choose File to select a document you need to convert to HTML.
Click Send to upload the selected file to the server and convert this document to HTML.

The result is displayed on the Response tab. Click Preview to see the generated HTML document.