How-to guides

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

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?