Overview

APIGit supports OpenAPI, AsyncAPI 2.x and 3.x, and GraphQL schemas in SDL in the same Git repository. Create or import files, edit them, review changes and publish them together with your guides. See Supported API Formats for file types and the tools available for each format.

OpenAPI has a visual form editor as well as code editing. New OpenAPI specs start at 3.0.3. Swagger 2.0 files are still accepted: they are converted to OpenAPI 3.0 when edited and saved. Removing the Swagger UI viewer has not removed support for those files.

A repository can also hold JSON Schema specs, Markdown documents and a navigation file.

Repository Dashboard

Select any spec file and click the pencil icon at the bottom of the file sidebar (tooltip edit document) to enter edit mode. You can also choose Edit from a file’s 3-dots menu. OpenAPI offers Form, Code, Diff, Governance and Preview tabs. AsyncAPI offers Code, Diff, Governance and Preview. GraphQL offers Code, Diff and Preview. Code editing uses the full panel; open Preview to see the rendered document.

Our self-developed, visual OpenAPI editor lets you create API specifications without writing OpenAPI by hand.

AsyncAPI governance checks event contracts in the browser. A GraphQL schema is validated in its Governance view (syntax and schema checks, without rule sets), and with lint in the CLI since 0.6.0.

API Design - Edit mode

Review and Commit Changes

Edits are kept as drafts until you commit them. The file sidebar in edit mode has two tabs, Files and Changes. The Changes tab shows the number of changed files and lists them with the base commit.

Changes tab with one modified file, next to the Diff view

Use the checkboxes to choose which files go into the commit
Use the revert icon to undo the changes in one file or in all files
Click Commit to enter a commit message and choose Commit directly to the current branch, or Create a new branch for this commit
Click Discard all drafts to remove every uncommitted draft in this view

You can leave edit mode with Exit edit and keep your drafts. If a conflict is found, resolve it before committing.

See Making Changes and Commits for the full flow.