API Document

API Documents turn the OpenAPI specs, AsyncAPI documents, GraphQL schemas and Markdown files in your API Repository into a documentation site. Because the content lives in Git, every version of your documentation is tied to an exact commit, reviewed like code, and published in a click. There is no separate docs tool to keep in step with your API.

An API Document has two kinds of content:

• API Spec: OpenAPI, AsyncAPI and GraphQL rendered with Redoc 3. OpenAPI also offers Try It Out and model code generation. See Supported API Formats.
• Markdown: guides and business context around the API, with rich components such as tabs, callouts and diagrams.

You can read them directly in the repository while you work, and publish them for your team, your partners or the public.

From repository to published site

1. Write. Add specs and Markdown to the repository. Use apigit.json to set the navigation and theme.
2. Preview. Working in a clone? apigit preview shows the site on your machine as it will look, before you commit.
3. Publish. Release a version from a branch or a commit. It gets its own URL, such as /apidoc/acme/petstore-platform/2.1.
4. Keep it current. A version stays on its commit until you publish again, or follows a branch so that every update reaches readers automatically (paid plans).
5. Share. Give each version its own access: members only, external viewers, password-protected links or the public, on your own custom domain if you like.

How versions work

A published document is a version name pointing at a commit. Publishing builds nothing: readers see the repository at that commit, so a publish is instant and always shows exactly what was committed.

Versions are identified by name, so you can run them side by side, even from one commit. For example, 2.1 can be pinned to your stable release for partners while next follows main for your own team. Each has its own URL, access rules and shared links.

What each plan includes

Public documents and OpenAPI Try It Out are available on every plan. Team and Enterprise add branch following and custom domains. Enterprise adds removal of the APIGit badge. Published-version counts, external-viewer allowances and fair-use ceilings are listed on the pricing page.