api-documentation-generator

Generate API documentation from source code by analyzing REST, GraphQL, and WebSocket APIs to extract endpoint details, request/response schemas, parameters, authentication requirements, and usage guidelines. This produces developer-friendly reference materials and OpenAPI/Swagger specifications automatically.

Create OpenAPI or Swagger specifications from an existing codebase by analyzing API endpoints, HTTP methods, and parameters directly from source code. This generates up-to-date specification files alongside example code snippets and usage notes for evolving APIs.

API documentation generation works for GraphQL and WebSocket APIs, as well as REST. It analyzes source code to extract endpoint details, request and response schemas, authentication requirements, and error handling for each protocol type.

Keep API docs updated for evolving APIs by generating documentation directly from source code. This ensures consistency and reduces manual writing effort by automatically extracting current endpoint details, schemas, and versioning information into OpenAPI specifications.

Automated code analysis extracts API endpoint details by parsing source code to identify HTTP methods, parameters, authentication requirements, and error handling. It generates corresponding request and response schemas, examples, and usage guidelines for developer onboarding.

You do not need existing code annotations to generate API reference materials. This skill analyzes the source code structure directly to produce endpoint details, authentication requirements, error handling documentation, and example code snippets automatically.