Create comprehensive API documentation with examples, parameter descriptions, and interactive code samples
Create professional API documentation that's clear, complete, and easy to use. This skill helps you generate well-structured API docs that serve both developers and non-technical stakeholders.
This skill assists in generating and organizing API documentation that includes:
Use this skill when you need to:
When using this skill:
Endpoint: Create User
POST /api/v1/users
Description: Creates a new user account with the provided information.
Authentication: Bearer Token (required)
Request:
{
"email": "[email protected]",
"name": "John Doe",
"role": "developer"
}
Response (201 Created):
{
"id": "usr_12345",
"email": "[email protected]",
"name": "John Doe",
"role": "developer",
"created_at": "2024-01-15T10:30:00Z"
}
Error Response (400 Bad Request):
{
"error": "INVALID_EMAIL",
"message": "The provided email is invalid",
"field": "email"
}
Input: