API Documentation Writer
Generates professional, developer-ready API reference documentation from raw specifications, Postman collections, or endpoint descriptions.
The API Documentation Writer skill streamlines the technical writing process by transforming raw API data into structured, developer-facing documentation. It ensures every endpoint is thoroughly documented with authentication requirements, request/response schemas, pagination details, and comprehensive error handling. By enforcing best practices and producing ready-to-use Markdown or prose, it helps engineering teams maintain high-quality developer portals, READMEs, and internal wikis without the manual overhead of formatting and boilerplate creation.
主な機能
01Converts Postman collections and raw specs into clean Markdown documentation
02Maps comprehensive error codes (400, 401, 404, 429, 500) with resolution steps
03959 GitHub stars
04Generates detailed request/response schemas with field types and descriptions
05Provides multi-language code examples including cURL and Python
06Enforces documentation best practices for enums, headers, and pagination
ユースケース
01Transforming a Postman collection into a public-facing developer portal
02Documenting new REST API endpoints for internal engineering handovers
03Creating standardized API reference sections for project README files