writing-api-documentation

To generate API documentation in Markdown, you provide an API specification and this Skill outputs comprehensive docs covering endpoints, authentication, parameters, request/response schemas, and executable curl examples for developers.

Documenting API authentication and error handling is best done using structured templates that clearly outline authentication requirements and provide comprehensive error code references, ensuring developer audiences understand access constraints and failure states.

Yes, you can generate documentation for GraphQL and RPC APIs, as the Skill supports multiple API architectures alongside REST, producing complete Markdown documentation sets tailored to each specific protocol's structure.

Yes, you need Python 3 installed in your environment, as it is a required dependency for running the scripts that generate the Markdown files with practical curl examples for each API endpoint.

Yes, it works with OpenAPI specifications by utilizing structured templates and validation rubrics to ensure quality and completeness, transforming your API definitions into clear, comprehensive developer guides.

If your API documentation is missing request and response schemas, apply validation rubrics to your specification to identify gaps and automatically generate the missing schema details within the Markdown output.