Task Templates
DocumentationBeginner15 min
API Documentation Generator
Generate comprehensive API documentation from endpoint specifications.
apidocumentationopenapirest
Overview
This template helps you generate thorough API documentation including request/response formats, examples, and error codes. Perfect for REST APIs and can be adapted for GraphQL.
When to Use
Use this when documenting new API endpoints, updating existing documentation, or creating API reference guides for your team or external developers.
Customize Template
Fill in the variables
The HTTP method for this endpoint
The URL path including parameters
What this endpoint does
Authentication requirements
Additional details about the request (body schema, query params, etc.)
Examples
User Creation Endpoint
Document a POST endpoint for creating users
Input values:
- http_method:
- POST
- endpoint_path:
- /api/v1/users
- description:
- Creates a new user account and sends a verification email
- auth_required:
- API Key
- request_details:
- Request body: { "email": "string (required)", "name": "string (required)", "role": "string (optional, default: user)" } Query params: - sendEmail: boolean (default: true)