openapi-generate-html
v0.5.3
Published
Generate standalone HTML from OpenAPI Specification
Maintainers
Readme
openapi-generate-html
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:
- Share : the file as a single, standalone document without additional dependencies.
- Hosting : the file on any server or serve it locally, with no need for additional resources or configurations.
- 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.

How to use
npx openapi-generate-html -i openapi.jsonUse dark theme 🌙
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 |
--ui=stoplight --theme=light sample |
--ui=stoplight --theme=dark sample |
| Swagger |
--ui=swagger --theme=light sample |
--ui=swagger --theme=dark sample |
| Redoc |
--ui=redoc --theme=light sample |
--ui=redoc --theme=dark sample |
License
This project is licensed under the terms of the MIT license.
