Supported API Formats

Keep REST APIs, event APIs and GraphQL schemas in one Git repository. APIGit renders OpenAPI, AsyncAPI and GraphQL SDL with its Redoc 3 viewer in the repository, the editor’s Preview tab and published documents.

The table below describes the production release of November 13, 2026. Follow-up capabilities are listed under Upcoming support.

Some actions depend on your plan or a published version’s settings. A dash means APIGit does not currently provide that feature for the format.

Create an AsyncAPI document

1. Open API & Documents in a repository and click + above the file tree.
2. Choose the AsyncAPI Spec card. Create a starter document or import a YAML or JSON file containing an asyncapi field.
3. Give it a path such as events/orders.yaml.
4. Edit in Code, inspect Diff, and open Preview to see the rendered channels, messages and schemas.
5. Commit the file, then publish a document version.

AsyncAPI documents can reference other files in the repository. APIGit resolves those references for the rendered preview. APIGit does not run an event broker or provide an AsyncAPI mock server.

Create a GraphQL schema

Choose GraphQL Schema in the same dialog, create a starter schema or import SDL, and use a path such as schema.graphql or api/schema.gql.

"""An order placed by a customer."""
type Order {
  id: ID!
  status: String!
}
 
type Query {
  order(id: ID!): Order
}

Use Code to edit the SDL with syntax highlighting, Diff to review it and Preview to read the rendered schema. The viewer includes query and response examples alongside types and fields. The source stays SDL when you commit. GraphQL introspection JSON is not an import format. The viewer documents the schema; it does not execute GraphQL queries.

Publish mixed documentation

An API Document publishes the repository at a commit, so one version can contain OpenAPI, AsyncAPI, GraphQL and Markdown together. Add each file to your navigation using its repository path.

The viewer’s Copy page menu copies the API document in its own format and downloads the original file. GraphQL downloads keep the .graphql or .gql extension.

Automatic AI agent outputs, including operation Markdown and MCP schema lookup, currently cover OpenAPI and Markdown. For an AsyncAPI document or GraphQL schema, use Copy page or download the file and give it to your agent.

Swagger 2.0 files and the viewer

Swagger 2.0 file support remains available. Swagger UI was removed as a separate viewer in November 2026. All three API formats use Redoc 3; code remains available to inspect the source. If a document cannot render, the viewer displays the error and its source text.

Upcoming support

The following additions are built for testing and have not been released to production:

• Agent-readable AsyncAPI and GraphQL: one generated Markdown page per file, included in llms.txt, full-text output, and document MCP search and outline. Separate operation/schema addresses and bundled-spec endpoints remain OpenAPI-only.
• More lint inputs: AsyncAPI best-practice checks in the browser, CLI and server lint; GraphQL syntax and schema checks through CLI lint. GraphQL governance in the browser and score for either new format are not included.
• Hosted GraphQL mocks: a schema mounted at /graphql on a spec-based mock server, with generated responses to queries and mutations. Subscriptions, persistent mutation state and local apigit mock serve for GraphQL are not included.

Use the production support table above until these additions are released.