api-documentation-generator
Generate Professional API Documentation
Also available from: CrazyDubya
Stop writing API docs manually and keep them outdated. This skill automatically generates comprehensive, developer-friendly documentation from your codebase with working examples.
Download the skill ZIP
Upload in Claude
Go to Settings → Capabilities → Skills → Upload skill
Toggle on and start using
Test it
Using "api-documentation-generator". Document a POST /users endpoint that creates user accounts
Expected outcome:
- ## Create User
- Creates a new user account.
- Endpoint: POST /api/v1/users
- Authentication: Required (Bearer token)
- Request Body: email (required), password (required, min 8 chars), name (required)
- Success Response: 201 Created with user object including id, email, name, createdAt
- Error Responses: 400 Validation Error, 409 Email Exists, 401 Unauthorized
- Examples provided in cURL, JavaScript fetch, and Python requests
Using "api-documentation-generator". Document GraphQL GetUser query with ID parameter
Expected outcome:
- ## User Query
- Fetch user information by ID.
- Query: GetUser($id: ID!) returns user object with id, email, name, role, posts
- Variables: id (required, ID type)
- Response: Data object containing user with nested posts array
- Errors: USER_NOT_FOUND with extension code and userId
Security Audit
SafeThis skill is a documentation generator that produces API documentation from codebases. Static analysis flagged 65 external_commands and 12 network patterns, but all are FALSE POSITIVES. The SKILL.md file contains only instructional markdown with code examples formatted using markdown backticks (not shell execution). URLs are documentation examples (api.example.com), not actual network calls. No executable code, no cryptographic implementations, and no system commands exist. Safe for publication.
Quality Score
What You Can Build
REST API Documentation
Generate complete endpoint documentation for REST APIs with request/response examples, authentication details, and error codes
GraphQL Schema Documentation
Create query and mutation documentation with variable specifications, response structures, and error formats
Developer Portal Content
Produce comprehensive API reference docs including getting started guides, authentication setup, and usage guidelines
Try These Prompts
Document this API endpoint: [paste code]. Include the HTTP method, URL path, request parameters, response format, and one code example.
Generate complete API documentation for this codebase: [paste files]. Include all endpoints, authentication requirements, request/response schemas, error codes, and code examples in cURL, JavaScript, and Python.
Convert this API code into an OpenAPI 3.0 specification: [paste code]. Include all paths, components, security schemes, and example values.
Update the API documentation based on these code changes: [show diff]. Identify new endpoints, modified parameters, and changed response formats. Provide updated documentation sections.
Best Practices
- Keep documentation close to code using comments or annotations to ensure they stay in sync
- Include working code examples tested against a sandbox or staging environment
- Document all error codes and edge cases, not just success scenarios
Avoid
- Writing documentation examples with placeholder data like foo and bar instead of realistic values
- Documenting only happy path scenarios without covering error handling
- Creating documentation as a separate artifact that gets forgotten when code changes
Frequently Asked Questions
What programming languages does this skill support?
Can this generate OpenAPI/Swagger specifications?
Does this skill test the documented endpoints?
Can this document GraphQL APIs?
How do I keep documentation updated when my API changes?
Can this create Postman collections?
Developer Details
Author
sickn33License
MIT
Repository
https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/api-documentation-generatorRef
main
File structure
📄 SKILL.md