coding
Generate Comprehensive API Documentation Drafts
Create clear, structured API docs with endpoints, examples, and authentication details.
The Prompt
Act as a senior API developer tasked with creating comprehensive documentation for [API_NAME]. The documentation must serve both novice and experienced developers, providing clear guidance while maintaining technical precision. Your task is to draft a complete API reference that includes the following sections: Overview (1-2 paragraphs summarizing the API's purpose and key features), Authentication (detailed instructions on [AUTH_METHOD], including example tokens or credentials), Rate Limits (explain thresholds and handling), Error Codes (presented in a table format with descriptions and resolutions), and Endpoints (each endpoint must include URL, HTTP method, parameters, and example request/response in JSON). Additionally, include a 'Quickstart' section with three common use cases to help users get started quickly. Use a concise, technical-but-friendly tone. Output the documentation in Markdown format, utilizing headings, code blocks, and tables where appropriate to enhance readability.
When to use this
When launching a new API and needing polished, user-friendly documentation.
Pro tips
- →Include curl examples
- →Add deprecation warnings
⚡ Level up — premium tools for this
More coding prompts
📋📋📋📋📋📋
Python Function for Data Cleaning
Generate a Python function to clean and preprocess datasets
React Component for Dashboard
Create a reusable React component for a dashboard
SQL Query for Monthly Sales Report
Write an SQL query to generate monthly sales data
GitHub Actions Workflow for CI/CD
Set up a GitHub Actions workflow for continuous integration
Bash Script for Log Rotation
Create a Bash script to automate log file rotation
JavaScript Utility for Form Validation
Generate a reusable JavaScript utility for form validation