PDF and Word export

Confluence PDF and Word exports contain the real API documentation: endpoint tables, parameters, fields, examples, cURL requests and data models, not an empty box.

When a page is exported to PDF or Word, each Apifolio macro becomes a static version of the documentation:

  • the API title, version and description, with its terms of service and documentation links;
  • the servers and a table of their variables;
  • the authentication methods, with OAuth 2.0 and OpenID Connect details (URLs, scopes and their descriptions) and Get a token requests with placeholders;
  • one table of endpoints per section (method, path, summary);
  • an Errors section when the error responses share one body;
  • endpoint details: authentication and scopes, the description, parameters with their notes and named examples, the request body with its fields and examples, the responses, the fields of the successful response, an example response and an example request in cURL;
  • a Data models appendix with the fields of the schemas the exported endpoints use (up to 150), when the macro's Schemas list option is on.

The export follows the macro's sections, endpoints and paths, Hide deprecated endpoints, and the show and hide options. Credentials never appear: requests use placeholders such as YOUR_TOKEN.

Limits

Each macro's export stays under 1.5 MB, so exports stay fast and reliable:

  • APIs with more than 250 endpoints (after filters) are exported as endpoint tables only. Narrow the macro to fewer sections or endpoints to export every detail.
  • When the details of every endpoint don't fit, every endpoint stays in the export and the extras give way first: some endpoints get only their top-level response fields, or no response field table. A note at the end says how many.
  • When even the endpoint tables don't fit, each section lists as many endpoints as fit and says how many it left out.

If a spec can't be read during export, the document shows a short note instead of failing.

Other ways to share a static copy

  • ⋯ → Copy as Confluence content pastes the same content into a page as native headings, tables and code blocks: see Public spaces.
  • ⋯ → Download as Markdown saves the API as a .md file.

View as Markdown