How to generate a static html file from a swagger documentation?

linux swagger api-doc html-generation
k0pernikus picture k0pernikus · Nov 3, 2016 · Viewed 19.3k times · Source

I have created a Swagger documentation with a yaml file under:

api/swagger/swagger.yaml

Now I want to share a static HTML document with its definition, yet it was stated on the swagger project, that they don't plan to support HTML generation at all.

How can I generate a static HTML file from a Swagger project?

Answer

William Cheng picture William Cheng · Nov 4, 2016

The easiest way I can think of is to use Swagger Editor:

  1. Go to: https://editor.swagger.io
  2. Click on "File" in the top menu bar and then select "Import File"
  3. After import, click on "Generate Client" in the top menu bar, and then select "HTML" or "HTML2" to generate static HTML documentation

editor.swagger.io uses generator.swagger.io to generate API clients, server stubs and documentation, and generator.swagger.io is powered by the open-source project Swagger Codegen.

Related questions

How do I find all files containing specific text on Linux?

I'm trying to find a way to scan my entire Linux system for all files containing a specific string of text. Just to clarify, I'm looking for text within the file, not in the file name. When I was looking …

Read More
How to change permissions for a folder and its subfolders/files in one step?

I would like to change permissions of a folder and all its sub folders and files in one step (command) in Linux. I have already tried the below command but it works only for the mentioned folder: chmod 775 /opt/lampp/…

Read More
How can I recursively find all files in current and subfolders based on wildcard matching?

How can I recursively find all files in current and subfolders based on wildcard matching?

Read More