Export API documentation to PDF, DOCX, HTML and Markdown
Sometimes an API needs to leave the portal: a document for a customer's security review, an attachment to a contract, a PDF for an auditor, a file for a partner without access to your network. The Export Wizard turns the parts of the documentation you choose into a file in a few clicks.
Choose exactly what goes in#
Pick services, folders, tag groups and single endpoints in a tree that mirrors your service structure. For each service you decide:
- the branch and version to export;
- an environment, so every endpoint gets a ready curl command;
- whether to use your overlay text;
- whether to include the change log of the versions up to the chosen one.
Then pick the format, the language of the static texts, and whether to include a table of contents.
Formats#
| Format | What you get |
|---|---|
| Outline and a clickable contents page. Bundled fonts render Cyrillic and other Unicode text. | |
| DOCX | Heading 1 to 6 styles, so Word's navigation pane shows the tree. |
| HTML | One self-contained page with embedded CSS, no JavaScript and no external resources. Works offline, follows the reader's light or dark setting and prints cleanly. |
| Markdown | One GitHub Flavored Markdown file with pipe tables, readable as source and in GitHub, GitLab or VS Code. |
Each endpoint gets its description, request parameters and body, responses, errors and request and response examples. Descriptions keep their Markdown formatting: bold, links, nested lists, quotes, code blocks and tables.
Cover pages and legal notices#
Documents sent outside the company usually need a cover, a confidentiality notice and contacts. Write these pages once in the cover page editor and add them before and after the generated content of any export.
Privacy of the result#
Generated files record that SelfDocHub produced them, with the application version and the generation time, and nothing else: no user, service or environment names. Every export is private to the user who started it, and the history lets you download, repeat or delete earlier ones.
Plans and quotas#
Exports need the export feature of your license and count against a monthly quota: 20 on Free, 200 on Team, 2,000 on Business and unlimited on Unlimited. At most two exports are generated at the same time.
