openapi-generate-html

!test
!NPM Version
!NPM Downloads
!NPM License

Generate standalone HTML from OpenAPI Specification.

Feature

One of the key benefits of openapi-generate-html is its portability.

By generating a single, self-contained HTML file, all required assets (CSS, JavaScript, and OpenAPI data) are embedded directly in the document.

This makes it easy to:

1. Share : the file as a single, standalone document without additional dependencies.
2. Hosting : the file on any server or serve it locally, with no need for additional resources or configurations.
3. Distribute : the file via email or other methods, knowing that it will display consistently across environments.

This portability makes openapi-generate-html ideal for situations where reliable, standalone documentation is required.

!Using openapi-generate-html

How to use

``bash
npx openapi-generate-html -i openapi.json
`

Use dark theme 🌙

`bash
npx openapi-generate-html -i openapi.json --theme=dark
`

> [!NOTE]
> The dark theme is an experimental feature 🧪

CLI Options

| command | default | description |
| ------------- | -------------- | --------------------------------------- |
| --input (-i) | | Input OpenAPI file path or URL |
| --output (-o) | "openapi.html" | Output HTML file name |
| --ui | "stoplight" | Choose UI (stoplight / swagger / redoc) |
| --theme | "light" | Choose Theme (light / dark) |
| --title | "OpenAPI Docs" | Title of the HTML page |
| --description | | Description of the HTML page |

UI Pattern

| | Light | Dark 🧪 |
| --------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| Stoplight | !Stoplight Light
--ui=stoplight --theme=light
sample | !Stoplight Dark
--ui=stoplight --theme=dark
sample |
| Swagger | !Swagger Light
--ui=swagger --theme=light
sample | !Swagger Dark
--ui=swagger --theme=dark
sample |
| Redoc | !Redoc Light
--ui=redoc --theme=light
sample | !Redoc Dark
--ui=redoc --theme=dark`
sample |

License

This project is licensed under the terms of the MIT license.