Specialist in creating comprehensive API documentation using OpenAPI/Swagger specifications.
Works with
AI-first code editor with Composer
Before installing skills in Cursor, ensure your development environment meets these requirements:
node --versionapi-documenterExecute the skills CLI command in your project's root directory to begin installation:
Fetches api-documenter from charon-fan/agent-playbook and configures it for Cursor.
The CLI shows a list of agents. Use arrow keys and space to select Cursor:
Confirm successful installation by checking the skill directory location:
Restart Cursor to activate api-documenter. Access via /api-documenter in your agent's command palette.
We perform automated surface-level scans (Gen AI Scanner, Socket, Snyk) during installation. These checks detect common vulnerabilities but do not guarantee complete security. Always review skill source code and verify the publisher's reputation before production use.
Skills execute code in your environment. Always review source, verify the publisher, and test in isolation before production.
Submit your Claude Code skill and start earning
Automate repetitive workflows and reduce manual effort
Example
Generate reports, summarize documents, draft communications
Save 3-5 hours per week on routine tasks
Learn new skills, understand complex topics, get expert guidance
Example
Explain concepts, provide examples, suggest learning resources
Accelerate learning and skill development by 2x
Enhance output quality through reviews, suggestions, and refinements
Example
Review drafts, suggest improvements, catch errors
Improve work quality by 30-40% with less effort
0
total installs
0
this week
27
GitHub stars
0
upvotes
Run in your terminal
0
installs
0
this week
27
stars
Specialist in creating comprehensive API documentation using OpenAPI/Swagger specifications.
Activates when you:
openapi: 3.0.3
info:
title: API Title
version: 1.0.0
description: API description
servers:
- url: https://example.com/api/v1
paths:
/users:
get:
summary: List users
operationId: listUsers
tags:
- users
parameters: []
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
components:
schemas:
User:
type: object
properties:
id:
type: string
name:
type: string
For each endpoint, document:
/users/{id}:
get:
summary: Get a user by ID
operationId: getUserById
description: Retrieves a single user by their unique identifier
tags:
- users
parameters:
- name: id
in: path
required: true
schema:
type: string
description: The user ID
responses:
'200':
description: User found
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'404':
description: User not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
schemas:
User:
type: object
required:
- id
- email
properties:
id:
type: string
format: uuid
description: Unique user identifier
example: "550e8400-e29b-41d4-a716-446655440000"
email:
type: string
format: email
description: User's email address
example: "[email protected]"
createdAt:
type: string
format: date-time
description: Account creation timestamp
Document auth requirements:
security:
- bearerAuth: []
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: Use your JWT token from /auth/login
Standard error format:
components:
schemas:
Error:
type: object
properties:
error:
type: string
description: Error message
code:
type: string
description: Application-specific error code
details:
type: object
description: Additional error details
Common HTTP status codes:
Generate OpenAPI spec from code:
python scripts/generate_openapi.py
Validate OpenAPI spec:
python scripts/validate_openapi.py openapi.yaml
references/openapi-template.yaml - OpenAPI templatereferences/examples/ - API documentation examplesPrerequisites
Time Estimate
15-45 minutes depending on use case complexity
Steps
Common Pitfalls
✓ Do
✗ Don't
💡 Pro Tips
✓ Use when
Use when skill capabilities match your task, clear ROI on time saved, and you can validate outputs. Best for repetitive tasks, learning, and quality improvement.
✗ Avoid when
Avoid when task requires deep expertise you can't validate, involves sensitive decisions, or when learning process is more valuable than speed of completion.
jwynia/agent-skills
mindrally/skills
kostja94/marketing-skills
github/awesome-copilot
wispbit-ai/skills
shubhamsaboo/awesome-llm-apps
Keeps context tight: api-documenter is the kind of skill you can hand to a new teammate without a long onboarding doc.
api-documenter has been reliable in day-to-day use. Documentation quality is above average for community skills.
I recommend api-documenter for anyone iterating fast on agent tooling; clear intent and a small, reviewable surface area.
api-documenter is among the better-maintained entries we tried; worth keeping pinned for repeat workflows.
api-documenter fits our agent workflows well — practical, well scoped, and easy to wire into existing repos.
Solid pick for teams standardizing on skills: api-documenter is focused, and the summary matches what you get after install.
api-documenter has been reliable in day-to-day use. Documentation quality is above average for community skills.
api-documenter reduced setup friction for our internal harness; good balance of opinion and flexibility.
api-documenter has been reliable in day-to-day use. Documentation quality is above average for community skills.
Solid pick for teams standardizing on skills: api-documenter is focused, and the summary matches what you get after install.
showing 1-10 of 71