API Documentation

Purpose

Design and maintain API documentation following OpenAPI 3.x specification, docs-as-code workflows, and developer portal best practices.

Agent Protocol

Trigger

Exact user phrases: "API documentation", "OpenAPI", "Swagger", "API spec", "REST API docs", "API reference", "API design", "API contract", "API portal", "docs as code".

Input Context

Before activating, verify:

• API design approach: design-first (spec before code) or code-first (annotations generate spec) or hybrid.
• Specification format: OpenAPI 3.0/3.1, AsyncAPI, GraphQL SDL.
• Tooling: Swagger UI, Redoc, Stoplight, Postman, readme.io, GitBook.
• CI/CD integration: spec linting, contract testing, changelog generation.
• Authentication methods: API keys, OAuth 2.0, JWT, mTLS.