Godly Prompts
Home
AI ModelsLeaderboard🛒 Marketplace
HomeCodingAPI Documentation Writer
Back to Coding Prompts
29

API Documentation Writer

codecraft@codecraft167 views3w agoVerified
Claude Sonnet 4.5CodingAPI

Generate professional API documentation with examples, schemas, and code snippets.

Prompt
You are a technical writer specializing in API documentation. Create comprehensive documentation for the following API endpoint:

**Endpoint**: {method and path}
**Purpose**: {what does this endpoint do}
**Authentication**: {type of auth required}

Generate documentation including:

## Overview
Brief description of the endpoint's purpose and use cases.

## Request
- **URL**: Full path with parameter placeholders
- **Method**: HTTP method
- **Headers**: Required headers with examples
- **Path Parameters**: Name, type, required, description
- **Query Parameters**: Name, type, required, default, description  
- **Request Body**: JSON schema with examples

## Response
- **Success Response**: Status code, body schema, example
- **Error Responses**: Common error codes with explanations

## Code Examples
Provide examples in:
- cURL
- JavaScript (fetch)
- Python (requests)

## Notes
- Rate limiting information
- Pagination details if applicable
- Common pitfalls and tips

Format in clear Markdown with proper code blocks.

💡 Tips for Best Results

  • •Works best with Claude Sonnet 4.5 or similar models
  • •Replace placeholders in {curly braces} with your specific content
  • •For better results, be as specific as possible with your inputs

Comments (11)

About the Author

codecraft - AI Prompt Creator

@codecraft

580 reputation

Prompts Shared4
Total Votes207
SpecializationCoding

Member since Nov 2025

The Art of the Prompt
FREE

From the Author

The Art of the Prompt

Get on Amazon

Related Prompts

â–² 87

Ultimate Python Debugging Assistant

Claude Sonnet 4.5
â–² 52

React Component Generator with TypeScript

Claude Sonnet 4.5
â–² 37

SQL Query Optimizer and Explainer

Claude Sonnet 4.5
â–² 48

Code Refactoring Expert

Claude Sonnet 4.5

Explore More

More Coding prompts →All Claude Sonnet 4.5 prompts →
Godly Prompts

The largest community-driven collection of AI prompts. Find, share, and vote on prompts that actually work.

Categories

  • Coding
  • Writing
  • Business
  • Research
  • Creative
  • Productivity

AI Models

  • ChatGPT / GPT-5
  • Claude 4
  • Gemini 3
  • Grok 4
  • Llama 4

Resources

  • Submit a Prompt
  • Leaderboard
  • About the Author
  • 📚 Get the Book
  • RSS Feed

Legal

  • Privacy Policy
  • Terms of Service
  • Contact Us

© 2025 Godly Prompts. All rights reserved.

Made with passion for the AI community