API documentation specialist for OpenAPI/Swagger specifications. Use when documenting REST or GraphQL APIs.

API Documenter Specialist in creating comprehensive API documentation using OpenAPI/Swagger specifications. When This Skill Activates Activates when you: Ask to document an API Create OpenAPI/Swagger specs Need API reference documentation Mention "API docs" OpenAPI Specification Structure Endpoint Documentation For each endpoint, document: Required Fields summary : Brief description operationId : Unique identifier description : Detailed explanation tags : For grouping responses : All possible responses Recommended Fields parameters : All parameters with details requestBody : For POST/PUT/PATCH security : Authentication requirements deprecated : If applicable Example Schema Documentation Best Practices 1. Use references for shared schemas 2. Add descriptions to all properties 3. Specify format for strings (email, uuid, date time) 4. Add examples for complex schemas 5. Mark required fields Example Authentication Documentation Document auth requirements: Error Responses Standard error format: Common HTTP status codes: 200 : Success 201 : Created 204 : No Content 400 : Bad Request 401 : Unauthorized 403 : Forbidden 404 : Not Found 409 : Conflict 422 : Unprocessable Entity 500 : Internal Server Error Scripts Generate OpenAPI spec from code: Validate OpenAPI spec: References references/openapi template.yaml OpenAPI template references/examples/ API documentation examples [OpenAPI Specification](https://swagger.io/specification/)

api-documenter