API Documentation Writer
Transforms raw API specifications and Postman collections into professional, developer-facing documentation.
The API Docs Writer skill empowers developers to generate high-quality, standardized API reference documentation from minimal inputs like raw specs, Postman exports, or verbal descriptions. It ensures consistency across endpoint summaries, authentication methods, request/response schemas, and comprehensive error handling. By following industry best practices for developer experience (DX), it produces ready-to-use Markdown or prose content suitable for READMEs, developer portals, or internal wikis, complete with realistic code examples in multiple languages and clear troubleshooting guidance.
主な機能
01Support for various auth methods, rate limits, and versioning notes
02Standardized endpoint documentation with detailed parameter tables
03Comprehensive error code mapping (4xx, 5xx) with resolution steps
04959 GitHub stars
05Automatic generation of request/response JSON schemas and examples
06Multi-language code examples including cURL and Python
ユースケース
01Converting a Postman collection into a public-facing developer portal
02Standardizing internal API documentation for Notion, Confluence, or GitHub READMEs
03Documenting new REST API endpoints during the development lifecycle