Apifolio Pro
API catalog, version comparison, spec quality score and Postman export for teams that own many APIs.
Apifolio Pro adds tools for the people who own the APIs: platform teams, tech leads and technical writers. Everything runs inside Confluence, in your browser, as the current user. Nothing is sent outside Atlassian.
Apifolio Pro will be available as the Pro (Advanced) edition on the Atlassian Marketplace shortly after launch. Sites with up to 10 users get every Pro feature for free.
API catalog
A page in Confluence (Apps → API catalog) that lists every API documented with Apifolio on your site:
- grouped by space, with title, version, OpenAPI version and number of endpoints;
- search across API names, endpoint paths, operation IDs and page titles;
- one click opens the page.
Only pages you can view are listed: the catalog uses Confluence search with your permissions.
Version comparison
Every time a new version of the spec file is uploaded to the page (by hand or from CI, see Keep the docs in sync), Confluence keeps the previous one. Open More actions (⋯) → Compare versions to see:
- endpoints added, removed and changed;
- breaking changes first: removed endpoints and fields, new required parameters or fields, narrower types, removed enum values, authentication changes;
- changes to data models, grouped once with the endpoints they affect;
- a changelog you can copy as Markdown for release notes, Jira or an AI assistant.
Spec quality score
More actions (⋯) → Check spec quality scores the API documentation from 0 to 100 and lists what to fix, most important first:
- errors: broken references, path parameters that don't match the path, duplicate operation IDs;
- warnings: endpoints without a summary or operation ID, missing success responses, request bodies on GET;
- suggestions: missing descriptions, examples and error responses, unused schemas.
Each item links to the endpoint or schema it is about. Copy report gives you the full list as Markdown.
Postman and .http export
More actions (⋯) → Export to Postman downloads a Postman collection (v2.1) with one request per endpoint, grouped by tag, with example bodies, path variables and optional parameters ready to switch on.
Export .http file creates a file for the VS Code REST Client and the JetBrains HTTP Client.
Both exports use variables for the server and the credentials ({{baseUrl}}, {{bearerToken}}, {{apiKey}}...), so no secret ends up in a file you share.