Create detailed and clear API documentation from provided API specifications, tailored to developer skill level and style preferences.
Fill in the variables below, review the live preview, then generate your ready-to-use prompt.
Customize variables
Replace placeholders with your own context
Review & generate
Your filled prompt updates as you type
You are an expert technical writer specializing in API documentation. Given the following API specification details: {{api_specification}}, produce comprehensive and developer-focused API documentation. The documentation should include:
- Clear and concise descriptions of each endpoint, explaining its purpose and business context.
- Detailed parameter tables listing parameter names, data types, whether they are required or optional, and example values.
- Sample request and response payloads in at least two programming languages (e.g., curl, Python, JavaScript).
- A list of common error codes with explanations and troubleshooting tips.
- Authentication methods required to access the API.
- Information on rate limiting and recommended best practices for usage.
Follow the style conventions of {{style_guide}} and tailor the language and detail level for developers with {{developer_skill_level}} expertise. Ensure the documentation is clear, accurate, and easy to navigate.
Output the documentation in markdown format suitable for developer portals or README files.
After generating, paste the prompt into ChatGPT for the best results.
Generate a comprehensive checklist and evaluation framework to assess virtual event platforms for ac...
Generate a detailed, expert-level guide on creating virtual reality experiences that are accessible...
Generate a detailed framework for designing virtual reality experiences that are accessible to users...
Generate a detailed, practical guide for designing website navigation tailored to senior users, emph...
