a6380d8a30
- Migrate SKILL.md files to new format (lowercase names, consolidated descriptions) - Remove deprecated fields: version, tags, when_to_use - Add Creating Custom Skills section with format requirements - Add Troubleshooting Guide and team sharing sections - Enhance Best Practices with specific examples - Remove Pre-built Skills section (no longer in official docs)
1.4 KiB
1.4 KiB
name, description
| name | description |
|---|---|
| api-documentation-generator | Generate comprehensive, accurate API documentation from source code. Use when creating or updating API documentation, generating OpenAPI specs, or when users mention API docs, endpoints, or documentation. |
API Documentation Generator Skill
Generates
- OpenAPI/Swagger specifications
- API endpoint documentation
- SDK usage examples
- Integration guides
- Error code references
- Authentication guides
Documentation Structure
For Each Endpoint
## GET /api/v1/users/:id
### Description
Brief explanation of what this endpoint does
### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | string | Yes | User ID |
### Response
**200 Success**
```json
{
"id": "usr_123",
"name": "John Doe",
"email": "john@example.com",
"created_at": "2025-01-15T10:30:00Z"
}
404 Not Found
{
"error": "USER_NOT_FOUND",
"message": "User does not exist"
}
Examples
cURL
curl -X GET "https://api.example.com/api/v1/users/usr_123" \
-H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const user = await fetch('/api/v1/users/usr_123', {
headers: { 'Authorization': 'Bearer token' }
}).then(r => r.json());
Python
response = requests.get(
'https://api.example.com/api/v1/users/usr_123',
headers={'Authorization': 'Bearer token'}
)
user = response.json()