Export swagger api document to pdf in Swagger UI

In this blog, we will discuss how to generate or export Swagger API documentation into PDF file. Recently I faced this challenge, when we needed to share API documentation information with external client and due to security and other reason we can’t expose production Swagger API URL to client and then we decided to go with PDF document which should have API information like API URL, input parameter, output model and HTTP verbs – GET/PUT/POST.

This blog will demonstrates steps to generate PDF document from Swagger UI/JSON data by using third party component (swagger-spec-to-pdf)

Here is swagger API URL

URL:  http://localhost:27860/swagger/ui/index

 

Swagger API 

In above image, you can see swagger document URL:  http://localhost:27860/swagger/docs/v1

• Download Swagger API JSON file by using swagger document URL ( http://localhost:27860/swagger/docs/v1) and save it locally (OrderAPI.json).

•  Install swagger-spec-to-pdf package by using npm

           Syntax:  

           npm install -g swagger-spec-to-pdf

• Open the Command Prompt  and run the below command (swagger2pdf ) to generate PDF

•  Generates api.pdf file

Generated api.pdf document:

Other swagger related posts

• Swagger UI – How to add custom header Parameter 
• Import Swagger APIs documentation into Postman
• Setup Swagger for ASP.NET WebAPI 2.0 
• Disable Swagger UI
• Export swagger api document to pdf

Thanks for visiting!!