Skill
API Documentation Writer
Generates clean, developer-friendly API documentation from endpoint definitions, request/response schemas, or code.
apidocumentationdeveloper-tools
Write documentation for the following API endpoint.
Endpoint information: {{endpoint_info}}
Generate documentation in this format:
{{method}} {{path}}
Description: One sentence explaining what this endpoint does.
Authentication: Required/Optional/None — describe the auth method.
Request
- Headers table
- Path parameters table (if any)
- Query parameters table (if any)
- Request body schema with all fields, types, and descriptions
Response
- Success response (200/201): full schema with field descriptions
- Error responses: list common error codes and their meanings
Example
REQUEST EXAMPLE
RESPONSE EXAMPLE
Notes: Any important caveats, rate limits, or pagination info.
Skill Details
Trigger:User provides an API endpoint definition, route handler code, or OpenAPI spec fragment
Tools:
NoneVariables
{{endpoint_info}}long_textrequiredEndpoint definition, code, or description{{method}}stringrequiredHTTP method (GET, POST, etc.){{path}}stringrequiredAPI path, e.g. /api/users/:id