RateMyPrompt

RateMyPrompt

Discover and share the best AI prompts, rated by AI & humans

API Documentation Generator

8.2/10Overall
8.2AI
No user ratings
Submitted Jul 18AI evaluated Jul 18

Prompt

Create comprehensive API documentation.

<api_overview>
- API name: {name}
- Version: {version number}
- Purpose: {what it does}
- Architecture: {REST/GraphQL/gRPC}
</api_overview>

<endpoints>
{list all endpoints with methods}
</endpoints>

<authentication>
{auth method and requirements}
</authentication>

<data_models>
{key objects and relationships}
</data_models>

Document:
1. Getting started guide
   - Prerequisites
   - Authentication setup
   - First API call
   - Common use cases
   
2. Endpoint reference
   - Request format
   - Parameters (required/optional)
   - Response structure
   - Error codes
   - Rate limits
   
3. Code examples
   - Multiple languages
   - Common scenarios
   - Error handling
   - Best practices
   
4. Advanced topics
   - Webhooks
   - Pagination
   - Filtering/sorting
   - Versioning

Use OpenAPI/Swagger format where applicable.

AI Evaluation

How we evaluate
Claude 3 Haiku
AI Evaluation
8.3/10
GPT-4 Mini
AI Evaluation
8.0/10

User Rating

No ratings yet. Be the first to rate!

Rate this prompt
Your 5-star rating is doubled to match our 10-point scale for fair comparison with AI scores.