Back to Prompts

API Endpoint Documentation

David Park David Park
May 19, 2026 ⏱️ 1 min read

Comprehensive API documentation template with request/response examples and error handling.

👁️ 350,869 views 📋 16,869 copies ❤️ 5,727 saves 👍 137 likes
Document the [endpoint name] API endpoint. ENDPOINT: [METHOD] /api/v1/[resource] AUTH: [Bearer Token / API Key / OAuth] REQUEST: ```json { "param1": "string (required) - description", "param2": "number (optional, default: 10) - description", "param3": "array of strings - description" } ``` SUCCESS RESPONSE (200): ```json { "status": "success", "data": { "id": "uuid", "createdAt": "ISO 8601 timestamp" } } ``` ERROR RESPONSES: 400 Bad Request: `{"status": "error", "message": "validation error"}` 401 Unauthorized: `{"status": "error", "message": "invalid API key"}` 404 Not Found: `{"status": "error", "message": "resource not found"}` 429 Rate Limit: `{"status": "error", "message": "rate limit exceeded"}` RATE LIMITING: [number] requests per [time window] CACHING: [Cache-Control header, TTL] PAGINATION: cursor-based, page token in response

Expected Output

Fill in the bracketed [placeholders] in the prompt above with your specific details and run it with your preferred AI model to generate a tailored output based on this template.

Usage Tips

  • 1 Use the "api" approach to get more relevant and targeted results from this prompt.
  • 2 Use the "documentation" approach to get more relevant and targeted results from this prompt.
  • 3 Use the "backend" approach to get more relevant and targeted results from this prompt.
  • 4 Use the "rest" approach to get more relevant and targeted results from this prompt.
  • 5 Use the "development" approach to get more relevant and targeted results from this prompt.

Frequently Asked Questions

What is this prompt used for?
This prompt is designed to help you generate high-quality outputs tailored to your specific needs. Simply replace the bracketed [placeholders] with your own details and use it with your preferred AI model.
Which AI models work best?
This prompt is optimized for the compatible models listed above. Different models may produce varying results based on their training and capabilities.
How do I customize this prompt?
Look for text in [brackets] and replace it with your specific details. You can also modify any section to better match your use case or style preferences.
Can I share this prompt?
Absolutely! Use the share button to send this prompt to others. You can also copy it and use it in your own projects.

Comments (3)

Alex Chen
Alex Chen Jun 24, 2026

This prompt saved me hours of work. The structure is incredibly well thought out.

Marcus Johnson
Marcus Johnson Jun 30, 2026

I used this for my latest project and got amazing results. Highly recommend!

Tom Wilson
Tom Wilson Jun 25, 2026

Is there a version optimized for Claude? The output was good but could be better.

Similar Prompts

View all →
Code

Database Schema Designer

Design normalized database schemas with relationships, indexes, and migration scripts.

🤖 ChatGPT🧠 Claude🔍 DeepSeek
👁️ 22,697 📋 4,125 ❤️ 3,497 ⏱️ 1 min read
David Park
David Park
More from Code