Write OpenAPI documentation and response examples with Claude Code

Use api-documentation to describe actual routes, parameters, response shapes, and error cases in OpenAPI.

Install in Claude Code

Claude Code and a local API route or existing OpenAPI schema.

Open the pinned GitHub source below and retrieve the `engineer/api-development/skills/api-documentation/` directory from that revision.
Copy it into `.claude/skills/api-documentation/` in your project, keeping `SKILL.md` and its companion files together.
Open Claude Code in the project root and enter `/api-documentation` followed by the example task.

Example task

Provide a sample GET /books/{id} route that returns id and title on 200 and an error field on 404. Ask for an OpenAPI fragment with one example for each response.

What to check

The fragment marks id as a required path parameter and documents both response payloads in the shape the route implements.

Original SKILL.md on GitHub · Updated 2026-11-11

Frequently asked question

How do I keep generated API docs aligned with the implementation?

Compare the spec to the route, response schema, and local examples whenever the endpoint changes.