Skills api-documentation
📦

api-documentation

Safe

Generate API Documentation

Also available from: CuriousLearner,sickn33

This skill helps developers create professional API documentation with OpenAPI specs, interactive Swagger UI, code examples, and reference guides for REST and GraphQL APIs.

Supports: Claude Codex Code(CC)
📊 70 Adequate
1

Download the skill ZIP

2

Upload in Claude

Go to Settings → Capabilities → Skills → Upload skill

3

Toggle on and start using

Test it

Using "api-documentation". Create OpenAPI spec for user management API

Expected outcome:

A complete OpenAPI 3.0 specification with /users endpoint, pagination, authentication, and response schemas

Using "api-documentation". Document the authentication flow

Expected outcome:

Step-by-step guide: 1. Login endpoint returns JWT, 2. Include Bearer token in Authorization header, 3. Token refresh mechanism, 4. Example curl commands

Using "api-documentation". Define API reference structure

Expected outcome:

Organized docs with: Overview, Authentication, Endpoints grouped by resource, Error Codes, Rate Limiting, Changelog

Security Audit

Safe
v1 • 3/7/2026

All 79 static findings are false positives. The skill contains only documentation templates with example URLs and code blocks. No actual shell commands, network exfiltration, or cryptographic vulnerabilities exist. The scanner triggered on markdown code delimiters, placeholder URLs in examples, and JWT authentication mentions in OpenAPI specs.

2
Files scanned
410
Lines analyzed
0
findings
1
Total audits
No security issues found
Audited by: claude

Quality Score

38
Architecture
100
Maintainability
87
Content
25
Community
100
Security
91
Spec Compliance

What You Can Build

Internal API Development

Document internal microservices APIs for frontend-backend team collaboration

Public API Release

Create professional documentation for external developers consuming your API

SDK Documentation

Generate comprehensive guides and reference docs for library consumers

Try These Prompts

Basic OpenAPI Spec 
Create an OpenAPI 3.0 specification for a REST API endpoint that manages users. Include GET (list), POST (create), GET by ID, PUT (update), DELETE endpoints. Define request/response schemas with proper HTTP status codes.
Authenticated Endpoints 
Document a protected API endpoint that requires JWT authentication. Include the auth flow, bearer token usage, 401/403 error responses, and example curl commands for authenticated requests.
Error Handling Guide 
Create a comprehensive error handling guide for a REST API. Document all common error codes (400, 401, 403, 404, 409, 429, 500), their meanings, example error responses, and recommended client handling approaches.
Interactive Docs Setup 
Set up Swagger UI for an Express.js API. Show how to integrate swagger-ui-express, load an OpenAPI YAML file, configure custom CSS, and mount the docs at /api-docs.

Best Practices

  • Provide working code examples in multiple languages (JavaScript, Python, curl)
  • Always document both success and error response cases with examples
  • Keep documentation synchronized with API changes using changelogs

Avoid

  • Using real API keys or passwords in example code
  • Leaving vague descriptions like 'returns data' without specifics
  • Missing error case documentation for failure scenarios

Frequently Asked Questions

What OpenAPI version does this skill support?
This skill supports OpenAPI 3.0.0 specification with examples for both YAML and JSON formats.
Can I generate documentation for GraphQL APIs?
Yes, you can document GraphQL schemas using the same documentation patterns. Include schema definitions, query/mutation examples, and type definitions.
How do I set up interactive Swagger UI?
Use swagger-ui-express for Node.js or swagger-ui-react for React. Load your OpenAPI YAML file and mount at a route like /api-docs.
What authentication methods are supported?
Common methods include JWT bearer tokens, API keys, and OAuth 2.0. The skill provides templates for documenting auth flows.
Can this skill test my actual API endpoints?
No, this skill generates documentation content. Use tools like Postman or curl to test actual endpoints separately.
How do I document rate limiting?
Include rate limit headers (X-RateLimit-Limit, X-RateLimit-Remaining), document limits per endpoint, and explain retry-after behavior.

Developer Details

License

MIT

Repository

https://github.com/supercent-io/skills-template/tree/main/.agent-skills/api-documentation/

Ref

main

File structure

📄 SKILL.md

📄 SKILL.toon