The Prompt
Write complete API documentation for the following endpoint: API details: - API name: [name] - Base URL: [https://api.example.com/v1] - Authentication: [API key/OAuth/JWT/none] - Format: [REST/GraphQL] Endpoint to document: - Method: [GET/POST/PUT/DELETE/PATCH] - Path: [/endpoint/path] - Description: [what this endpoint does] - Use case: [when to use this] Request: - Headers required: [list] - Path parameters: [list with types] - Query parameters: [list with types] - Request body: [JSON schema] Response: - Success response (200/201): [JSON example] - Error responses: [list with codes and meanings] Documentation should include: 1. Endpoint overview 2. Authentication section 3. Request format with all parameters explained 4. Complete request example (curl and code) 5. Response format explained 6. Complete response example 7. Error codes and handling 8. Rate limiting information 9. Code examples in JavaScript and Python 10. Common use cases Write in clear technical English Use proper markdown formatting
Copied 1 times
How to Use This Prompt
- Click Copy Prompt above
- Open ChatGPT or Claude
- Paste the prompt and replace anything in [brackets] with your own details
- Press Enter and get your result instantly
Pro Tip
The more specific you are when replacing the [brackets], the better your result. For example instead of writing [Job Title] write "Senior Software Engineer with 5 years experience" — specificity is what separates a good AI response from a great one.
This prompt works best with ChatGPT . If you are not happy with the first result, try adding "make it more concise" or "give me 3 alternative versions" as a follow-up message.