charon-fan/api-documenter
skills/api-documenter/SKILL.md
API documentation specialist for OpenAPI/Swagger specifications. Use when documenting REST or GraphQL APIs.
$ install --global
skillsauthnpx skillsauth add charon-fan/agent-playbook api-documenterInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 17, 2026, 2:18 PM7.7s7 files scanned
SKILL.md
- name:
- api-documenter
- description:
- API documentation specialist for OpenAPI/Swagger specifications. Use when documenting REST or GraphQL APIs.
- allowed-tools:
- Read, Write, Edit, Bash, Grep, Glob
- - trigger:
- session-logger
- mode:
- auto
- reason:
- Log documentation activity
API Documenter
Specialist in creating comprehensive API documentation using OpenAPI/Swagger specifications.
When This Skill Activates
Activates when you:
- Ask to document an API
- Create OpenAPI/Swagger specs
- Need API reference documentation
- Mention "API docs"
OpenAPI Specification Structure
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
Endpoint Documentation
For each endpoint, document:
Required Fields
- summary: Brief description
- operationId: Unique identifier
- description: Detailed explanation
- tags: For grouping
- responses: All possible responses
Recommended Fields
- parameters: All parameters with details
- requestBody: For POST/PUT/PATCH
- security: Authentication requirements
- deprecated: If applicable
Example
/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'
Schema Documentation
Best Practices
- Use references for shared schemas
- Add descriptions to all properties
- Specify format for strings (email, uuid, date-time)
- Add examples for complex schemas
- Mark required fields
Example
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
Authentication Documentation
Document auth requirements:
security:
- bearerAuth: []
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: Use your JWT token from /auth/login
Error Responses
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:
- 200: Success
- 201: Created
- 204: No Content
- 400: Bad Request
- 401: Unauthorized
- 403: Forbidden
- 404: Not Found
- 409: Conflict
- 422: Unprocessable Entity
- 500: Internal Server Error
Scripts
Generate OpenAPI spec from code:
python scripts/generate_openapi.py
Validate OpenAPI spec:
python scripts/validate_openapi.py openapi.yaml
References
references/openapi-template.yaml- OpenAPI templatereferences/examples/- API documentation examples- OpenAPI Specification
Related Skills
charon-fan/workflow-orchestrator
data-ai
VerifiedTrustedCommunity
Automatically coordinates multi-skill workflows and triggers follow-up actions. Use when completing PRD creation, implementation, or any milestone that should trigger additional skills. This skill reads the auto-trigger configuration and executes the workflow chain.
57SKILL.mdUpdated Apr 17, 2026
charon-fan/skill-router
development
VerifiedTrustedCommunity
Intelligently routes user requests to the most appropriate Claude Code skill. ALWAYS use this skill FIRST when user asks for help, mentions "skill", "which", "how to", or seems unsure about which approach to take. This is the default entry point for all skill-related requests.
57SKILL.mdUpdated Apr 17, 2026
charon-fan/session-logger
tools
VerifiedTrustedCommunity
Saves conversation history to session log files. Use when user says "保存对话", "保存对话信息", "记录会话", "save session", or "save conversation". Automatically creates timestamped session log in sessions/ directory.
57SKILL.mdUpdated Apr 17, 2026
charon-fan/self-improving-agent
development
VerifiedTrustedCommunity
A universal self-improving agent that learns from ALL skill experiences. Uses multi-memory architecture (semantic + episodic + working) to continuously evolve the codebase. Auto-triggers on skill completion/error with hooks-based self-correction.
57SKILL.mdUpdated Apr 17, 2026