How-to guides

Each guide takes one job from the first command to CI. New to API Genie? Start with the Quickstart.

• Lint and format API descriptionsGive every API description of a repository the same rules and the same style, locally and in every pull request.Lint and format →
• Catch breaking changes in CIFail the pull request that would break your clients, retire old operations on a schedule, and keep a changelog from git.Catch breaking changes →
• Generate a client and a serverGenerate a typed client and a server from one OpenAPI document, keep your code out of the generated files, and regenerate in CI.Generate code →
• Mock and contract-test an APIServe an API from its contract before the server exists, then check the real server against the contract in CI.Mock and test →
• Publish API documentationBuild a documentation site from your API descriptions, translate it, add the changelog of each API, or put a reference into a page of your own.Publish API docs →
• Edit an API in formsOpen a folder of OpenAPI or AsyncAPI files in the editor, change them in forms, and review the change like any other.Edit visually →
• Catalog the APIs of a repositoryList every API specification of a repository, give each a stable name and an owner, and keep the catalog current in CI.Catalog your APIs →
• Work with AI agentsPut the linter, the diff and the formatter in a coding agent's loop, so that what it changes in a contract is checked the way a person's change is.Work with AI agents →