Write Professional API Documentation
Generate comprehensive API documentation with clear endpoints, parameters, and examples. Perfect for developers and technical writers.
Prompt Template
Variables to Customize
[API_NAME] The name of your API or service
Example: TaskFlow API
[BASE_URL] The base URL for your API
Example: https://api.taskflow.com/v1
[AUTH_METHOD] Authentication method used by the API
Example: Bearer token in Authorization header
[ENDPOINTS_LIST] List of main API endpoints to document
Example: GET /tasks, POST /tasks, PUT /tasks/{id}, DELETE /tasks/{id}
[TARGET_DEVELOPERS] Primary audience for the documentation
Example: web developers building productivity applications
[ADDITIONAL_CONTEXT] Any special requirements or context
Example: This API supports real-time webhooks and bulk operations
Example Output
Pro Tips for Best Results
- Provide working code examples in multiple programming languages to increase usability
- Include realistic sample data in your examples rather than generic placeholders
- Document error scenarios and edge cases that developers commonly encounter
- Add interactive elements like copy-to-clipboard buttons for code examples if publishing online
- Test all examples thoroughly before publishing to ensure they work as documented
Tags
Want 500+ Expert Prompts?
Get the Premium Prompt Pack — organized, tested, and ready to use.
Get it for $29Related Prompts You Might Like
Implement Data Serialization for APIs
You are an expert backend developer specializing in data serialization for APIs. I need you to implement a complete data...
Debug Python Syntax Errors
You are an expert Python debugger helping beginners fix syntax errors. I need you to analyze the following Python code t...
Handle Concurrent Data Access in Database Systems
You are a senior database engineer specializing in concurrent systems design. I need you to design a comprehensive solut...
Generate a Comprehensive Code Review Checklist
Act as a senior software engineer and create a comprehensive code review checklist for [PROGRAMMING_LANGUAGE] projects. ...
Implement API Pagination System
I need to implement pagination for a REST API endpoint. Please provide a complete implementation with the following requ...
Configure Production Load Balancer Architecture
You are a senior DevOps engineer specializing in high-availability infrastructure. I need to set up a production-grade l...