# How-to guides

Source: https://apigenie.pl/docs/guides

Each guide takes one job from the first command to CI. New to API Genie? Start with the [Quickstart](/docs/quickstart.md).

- [Lint and format API descriptions](/docs/guides/lint-and-format-api-descriptions.md): Give every API description of a repository the same rules and the same style, locally and in every pull request.
- [Catch breaking changes in CI](/docs/guides/catch-breaking-changes-in-ci.md): Fail the pull request that would break your clients, retire old operations on a schedule, and keep a changelog from git.
- [Generate a client and a server](/docs/guides/generate-a-client-and-a-server.md): Generate 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.
- [Mock and contract-test an API](/docs/guides/mock-and-contract-test-an-api.md): Serve an API from its contract before the server exists, then check the real server against the contract in CI.
- [Publish API documentation](/docs/guides/publish-api-documentation.md): Build 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.
- [Edit an API in forms](/docs/guides/edit-an-api-in-forms.md): Open an OpenAPI or AsyncAPI file in the editor, change it in forms, and review the change like any other.
- [Catalog the APIs of a repository](/docs/guides/catalog-the-apis-of-a-repository.md): List 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.
- [Work with AI agents](/docs/guides/work-with-ai-agents.md): Put 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.

## 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 Spectral](/docs/guides/migrate-from-spectral.md): Move a repository from Spectral to apigenie lint: the ruleset, your custom rules and functions, the CI step, and what has no counterpart.
- [Migrate from Prism](/docs/guides/migrate-from-prism.md): Move 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 Generator](/docs/guides/migrate-from-openapi-generator.md): Move 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 Buf](/docs/guides/migrate-from-buf.md): Move 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 CLI](/docs/guides/migrate-from-redocly.md): Move 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 oasdiff](/docs/guides/migrate-from-oasdiff.md): Move 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 APIs](/docs/guides/industry/lint-camara-apis.md): Check 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.
