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, in TypeScript, Java, Go, Python, C# or Elixir, keep your code out of the generated files, and check them 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 an OpenAPI or AsyncAPI file in the editor, change it 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, keep the catalog current in CI, and release a specification as a Git tag.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
Coming from another tool
Each guide moves a repository from one tool to API Genie: what changes, what stays, and what has no counterpart.
- Migrate from SpectralMove a repository from Spectral to apigenie lint: the ruleset, your custom rules and functions, the CI step, and what has no counterpart.
- Migrate from PrismMove a repository from Prism to apigenie-server: the mock, the Prefer header, request validation, the validation proxy, the CI step, and what has no counterpart.
- Migrate from OpenAPI GeneratorMove a repository from OpenAPI Generator to apigenie-generator: the generators by name, the options, the files you own, the CI step, and what has no counterpart.
- Migrate from BufMove the linting, breaking-change checks and formatting of Protobuf files from Buf to apigenie: the rules by name, buf.yaml, the CI step, and what stays with Buf.
- Migrate from Redocly CLIMove a repository from Redocly CLI to apigenie: the rules by name, redocly.yaml, configurable rules, decorators as overlays, the bundle, the CI step, and what stays with Redocly.
- Migrate from oasdiffMove the breaking-change check of a repository from oasdiff to apigenie diff: the checks as rules, the exit status, sunset dates, the formats, the CI step, and what has no counterpart.
By industry
Each guide sets up a repository that follows an industry's own API rules.
- Lint CAMARA APIsCheck the APIs of a CAMARA repository with CAMARA's own rules, locally and in every pull request, without a copy of its ruleset or a Node toolchain.
Was this helpful?