OpenAPI to Static API Docs (One HTML File or Markdown)
An API reference you can host anywhere: one HTML file, Markdown pages or a PDF.
Try before you buy.
- Free preview: the first operations of the docs page (up to 10) under a MySmartCoPilot mark, or the list of Markdown files and the first lines (up to 20) of the first ones.
- Locked until you unlock it: download and copy.
- Unlock: Premium pass, ₹799 for 30 days or ₹249 for 1 week, a one-time payment that never renews. Unlock: Premium pass, $19.99 for 30 days or $7.99 for 1 week, a one-time payment that never renews.
Ways to unlock shows how to get the full result.
Printing this result is locked in the free preview.
OpenAPI 3.0, 3.1, 3.2 or Swagger 2.0, in YAML or JSON. A split description: open or drop all its files (or the folder).
Problems
Export
Your documentation
Locked in the free preview. Opens the ways to unlock this result.
Locked in the free preview. Batch runs unlock with a pass.
Locked in the free preview. Query results unlock with a pass.
About the OpenAPI to Static API Docs (One HTML File or Markdown)
Paste or open an OpenAPI 3.0, 3.1 or 3.2 description — or a Swagger 2.0 one — and get documentation you can put anywhere: one HTML file with a sidebar, a search box, every operation with its parameters, request body, responses, examples and a curl command, and the reusable schemas; Markdown pages for a docs site or a wiki; or a print-ready page to save as a PDF.
Choose the title, a light, dark or automatic theme, an accent colour and a logo, and which tags to include. Operations marked x-internal: true can be left out, and examples are built from the schemas where the description has none. A description split into several files is bundled first, and its problems are listed with their paths. The HTML page carries everything inside it and loads nothing from the internet: no fonts, no scripts from elsewhere, no tracking.
Without a pass the result is a free preview: the first operations of the docs page under a MySmartCoPilot mark, or the list of Markdown files with the first lines of the first ones. The whole docs, the downloads and the print-ready page unlock with a Premium pass.
How to use it
- Paste the description, open the file, or drop it on the box. For a description split into several files, open all of them at once, or the folder.
- Check the Problems list: the docs can still be made, but errors usually mean something is missing from them.
- Choose One HTML page, Markdown pages or Print / PDF (each downloads with a Premium pass), then the title, theme, accent colour, logo, tags and content options.
- Press Create the docs. The HTML page is previewed beside the settings (without a pass, its first operations under a MySmartCoPilot mark), and changes to the settings update it.
- With a Premium pass, or after unlocking this result, download the HTML file (or the Markdown ZIP). For a PDF, open the print-ready page in your browser (also with a Premium pass) and choose Print → Save as PDF.
Examples
POST /holds — requestBody: NewHold (eventId, seats[1–10], email) responses: 201 Hold, 409 Problem security: oauth [orders:write]
POST /holds · Hold seats Authentication: oauth (orders:write) Request body (required): eventId string (uuid) required · seats array of string required, 1–10 items · email string (email) Example (built from the schema) · Responses: 201, 409 · Example request: curl …
Markdown pages, one page per tag
orders.md: ## Hold seats `POST /holds` ### Request body (required) | Property | Type | Required | Description | | `seats` | array of string | yes | (1–10 items) |
Common uses
- Publishing an API reference on any web server, an intranet or a file share, without a docs platform.
- Adding API pages to a Docusaurus, MkDocs or Hugo site, or to a repository wiki.
- Sending a partner the reference of the public part of an API, with the internal operations left out.
- Attaching a PDF of the API to a contract, a tender or an audit.
What the HTML page contains
- The introduction from
info(Markdown rendered), the servers, contact and licence. - Authentication: each security scheme, with OAuth 2.0 flows and their scopes; every operation links to what it needs.
- The operations grouped by tag, each with its parameters (type, required, limits, enum values, examples), request body and responses per media type, response headers, examples (the description’s own, named ones included, or built from the schema) and a curl command.
- Webhooks, and every reusable schema with its properties (allOf parts merged, references linked) and an example.
- A sidebar, a search box (press /; it finds operations by path, summary, operation ID or parameter, and allows one typo), a light / dark / automatic theme switch and copy buttons. On phones the sidebar becomes a menu.
No requests, no tracking
The page holds its styles, its script and your logo inside the file. It includes a Content-Security-Policy that allows only that one style sheet and that one script (by their SHA-256 hashes) and images inside the file, so even a description that tried to load something could not. Descriptions are Markdown with raw HTML switched off, and links with unsafe schemes such as javascript: are not made links. The optional credit line is a plain link.
Markdown pages
The ZIP holds README.md (introduction, servers, authentication and contents) and one page per tag — or one per operation, in a folder per tag, or everything in one file — plus schemas.md. Parameters and the properties of bodies are tables; nested properties are written as paths (venue.city, items[].name). Links between pages use the heading anchors GitHub, MkDocs and Docusaurus make. Turn on front matter for docs sites that read a title and sidebar position from it.
Internal and deprecated operations
Operations, path items, tags and schemas marked with the widely used x-internal: true extension are left out by default, so one description can serve both internal and public documentation. Deprecated operations are kept and marked, or left out with the option. Choosing tags limits the reference to those sections; operations without a tag are listed under Other.
Limitations
- Descriptions are rendered as CommonMark without raw HTML; HTML written inside a description is shown as text.
- Callbacks and links are named but not documented in detail.
- Schema keywords such as
not,if/then/elseandpatternPropertiesare not shown in the property lists. - References to other files are bundled from the files you open; references to URLs are not loaded.
- The live preview needs a connection; the downloaded files do not. Pages over about 1 MB are not previewed here.
Privacy
On this device; its files download once
Everything happens in your browser. What you enter or open here is not uploaded or stored by MySmartCoPilot. The live preview runs in an isolated frame loaded from a separate MySmartCoPilot address; the page is handed to it inside your browser and never uploaded. Making and downloading the files needs no connection.
Frequently asked questions
What do I get without a pass?
Without a pass, OpenAPI to Static API Docs (One HTML File or Markdown) shows the first operations of the docs page (up to 10) under a MySmartCoPilot mark, or the list of Markdown files and the first lines (up to 20) of the first ones. Until you unlock it, the result can’t be downloaded or copied. A Premium or Ultimate pass, a one-time payment that never renews, unlocks the full result. The pricing page lists the passes and their prices.
Is my API description uploaded?
No. Reading, checking and writing the pages run in your browser, in a background worker. The live preview is drawn in an isolated frame from a separate MySmartCoPilot address; the page is handed to that frame inside your browser, never sent over the network.
Can I host the HTML file on GitHub Pages or any web server?
Yes. It is one file with no other files beside it: upload it, name it index.html if you like, and it works. It also works opened straight from a disk or an e-mail attachment.
How do I make a PDF?
With a Premium pass, choose Print / PDF, download the page, open it in your browser and press Ctrl+P (⌘P on a Mac), then choose Save as PDF. Every response and nested property is open, and each tag starts on a new page.
Where do the generated examples come from?
From the schemas: formats such as date-time, email and uuid get realistic values, numbers keep within minimum and maximum, read-only properties are left out of requests and write-only ones out of responses. The description’s own examples always win, and generated ones are labelled “built from the schema”. Turn them off in Content to show only the description’s own.
How is this different from the OpenAPI / Swagger Editor?
The OpenAPI / Swagger Editor checks and edits a description and shows a reference on its page. This makes files from it to publish elsewhere. Use the OpenAPI Diff to see what changed between two versions before you publish.