Aspose words returning pdf as stream does nothing asp net web api


ASP.NET is a popular programming language used for building web applications. It provides a framework for developing dynamic websites, web services, and web APIs. One common requirement in web is generating PDF files from various sources. In this article, we will explore how to use Aspose.Words to a PDF as a stream in an ASP.NET Web API.

Setting up the Environment

Before we dive into the code, let's make sure we have the necessary tools and libraries installed. First, we need to have ASP.NET and the Aspose.Words library installed on our development machine. You can download and install the latest of ASP.NET from the official Microsoft website. Aspose.Words is a third- library that provides advanced document processing capabilities. You can obtain the library from the Aspose website and follow their installation instructions.

Creating the ASP.NET Web API Project

Let's start by creating a new ASP.NET Web API project. Open Visual Studio and select “New Project” from the File menu. the “ASP.NET Web Application” template and provide a name for your project. Select the “Web API” template and click “OK” to create the project.

Aspose.Words to the Project

Once the project is created, we need to add a reference to the Aspose.Words library. Right-click on the “” folder in the Solution Explorer and select “Add Reference”. Browse to the location where you installed the Aspose.Words library and select the appropriate DLL file. Click “OK” to add the reference to your project.

the API Endpoint

Now that we have our project set up and the necessary libraries added, let's implement the API endpoint that will generate and return the PDF as a stream. Open the “Controllers” folder in the Solution Explorer and add a new Web API controller. Name it “PdfController” or any other name that suits your project.

public class PdfController : ApiController
    public HttpResponseMessage GetPdf()
        // Generate the PDF  Aspose.Words
        Document doc = new Document();
        // Add content to the document

        // Save the document as a stream
        MemoryStream stream = new MemoryStream();
        doc.Save(stream, SaveFormat.Pdf);

        // Create the HTTP response
        HttpResponseMessage response = new HttpResponseMessage(HttpStatusCode.OK);
        response.Content = new StreamContent(stream);
        response.Content.Headers.ContentType = new MediaTypeHeaderValue("application/pdf");

        return response;

In the above code snippet, we a new API endpoint with the route “api/pdf”. The endpoint is an HTTP GET method that returns an HttpResponseMessage. Inside the method, we create a new instance of the Aspose.Words Document class and add content to it. We then save the document as a stream using the SaveFormat.Pdf option.

Returning the PDF as a Stream

To return the PDF as a stream, we create a new MemoryStream and save the document into it. We then create a new HttpResponseMessage and set its content to a StreamContent object, passing the MemoryStream as the parameter. Finally, we set the content type of the response to “application/pdf” to indicate that we are returning a PDF file.

Testing the API Endpoint

Now that we have implemented the API endpoint, let's test it to see if it returns the PDF as expected. Build and run the project, and navigate to the URL of your API endpoint (e.g., http://localhost:port/api/pdf). You should see the PDF file being downloaded or displayed in your browser, depending on your browser settings.


In this article, we have explored how to use Aspose.Words to return a PDF as a stream in an ASP.NET Web API. We have seen how to set up the environment, add the necessary libraries, implement the API endpoint, and test the functionality. Generating and returning PDF files as streams is a common requirement in web development, and with the help of Aspose.Words, it becomes a straightforward task in ASP.NET.

Rate this post

Leave a Reply

Your email address will not be published. Required fields are marked *

Table of Contents