Alidade

API documentation that stays correct

Alidade makes one Confluence app: Swagger UI, OpenAPI Docs & API Catalog for Confluence. It renders an OpenAPI or Swagger specification on a Confluence page — and then does the part the rest of the category leaves out.

Every operation, path and tag from every specification is published to Confluence's own search index. Someone searching for POST /v2/invoices, or for a tag, or for an operation id, lands on the page that documents it.

A rendered macro is invisible to Confluence search. This is real indexed content, and it answers CQL queries too.

One catalog of every API you document

A page under the Apps menu lists every specification published with the macro, across every space: title, version, endpoint count, where it lives, and how long since it changed.

It is built from a single search request, made as you — so it shows exactly the pages you are allowed to see, and it never crawls your instance.

Four ways in, and none of them ask for a credential

Paste a document. Point at a public URL. Pick a page attachment. Or have your CI pipeline push it — which is how a specification in a private repository gets here without anyone handing us a repository token.

This app stores no repository credential, ever. That is a rule, not a setting. Your pipeline already holds the credential; it never leaves your side. Several apps in this category keep one as a macro parameter, which puts it in the page body — how to check whether yours does.

Already have a Swagger macro on 200 pages

Another vendor's macro stores its configuration in the Confluence page, not in that vendor's storage, so it can be read and converted. Scan a space, read a dry run that writes nothing, choose the pages, apply — and undo if you want it back.

Which apps can be read today, and which are reported and deliberately left alone, is on the migration page. It is a shorter list than you might hope, and it says so rather than guessing at a macro it cannot read.

What it does not do is written down

The limitations page is published and kept current. It was written alongside the product rather than after the first bad review, and it says plainly where the platform stops us and where we stopped ourselves.

Read it before you buy.

Read the documentation · Moving from another app · Limitations · Support