API docs in Confluence that tell you what changed.

API Docket renders OpenAPI and Swagger files as interactive documentation on Confluence pages, keeps them in sync with your repository, and records every change to the contract, flagging the ones that break clients.

Get it on the Marketplace Read the docs

Free for Confluence sites with up to 10 users. Built on Atlassian Forge.

payments-api.yaml · mainv2.3.0 → v2.4.0
  /payments/{id}:    get:      parameters:        - name: expand          in: query          required: true      responses:        '200':          properties:            amount: { type: integer }            currency: { type: string }            status: { enum: [pending, settled] }

Changelog on the Confluence page

  • BreakingAdded required query parameter expand
  • BreakingRemoved field response 200 → currency
  • ChangeAdded field response 200 → status
  • ChangeVersion changed from 2.3.0 to 2.4.0

Point it at the file you already maintain.

Insert the macro, choose where the specification lives, and API Docket does the rest. Linked files are re-checked on a schedule you control, so the page never drifts from the code.

  • GitHub
  • GitLab (incl. self-managed)
  • Bitbucket Cloud
  • Any URL
  • Page attachment
  • Paste YAML or JSON
  • Private repositories, with guardrails

    Confluence admins add access tokens once. Each one is limited to the repositories or URL prefixes they allow, so page editors can't use it to read anything else.

  • OpenAPI 3.0, 3.1 and Swagger 2.0

    Full Swagger UI: operations, schemas, examples and authentication, styled to match Confluence in light and dark mode.

  • Large specifications

    Documents up to 20 MB are compressed and cached, so pages stay fast for every reader.

“Try it out” that actually sends the request.

In most Confluence API macros, the Try it out button fails with a CORS error because the browser blocks requests from inside Confluence. API Docket can relay the request for you instead.

Requests are only sent to the servers declared in that specification, and admins can switch the relay off for the whole site.

A changelog people will actually read.

Every time the specification changes, API Docket compares the two versions and records what changed for API consumers: removed endpoints, new required inputs, missing response fields and type changes are flagged as breaking.

Description-only edits are recognised as such, so the history stays quiet unless the contract moved.

Moving off a Connect app?

Atlassian ends support for Connect apps on January 31, 2027. Several popular OpenAPI macros still run on Connect and haven't been updated in years. API Docket runs on Forge, Atlassian's current platform, and accepts the same files and URLs.

Read the migration guide

Runs on Atlassian infrastructure.

API Docket has no servers of its own. Cached specifications, history and connection tokens live in Atlassian Forge storage. Nothing is sent to us.

Security details

Questions

How much does it cost?
API Docket is billed through the Atlassian Marketplace, per Confluence user, like other Marketplace apps. Sites with up to 10 users use it for free, and every plan starts with a 30-day free trial.
Who can see the documentation?
Anyone who can view the Confluence page. API Docket fetches attachments as the reading user, so page and space permissions are respected.
Does it work with Confluence Data Center?
No. API Docket is built for Confluence Cloud on Forge.
Something isn't working.
Email support@apidocket.com. We usually reply within one business day.