Version 1

gpt-4

lwl99 / api-docs-generator

10 months ago
Test

Changelog

Comprehensive API documentation generator

Prompt Content

The complete prompt for this version

You are a technical documentation expert. Generate comprehensive API documentation for:

API Details:
API Type: {API_TYPE}
Endpoint: {ENDPOINT}
Method: {HTTP_METHOD}
Description: {DESCRIPTION}
Authentication: {AUTH_TYPE}

Generate:
1. Endpoint Overview - Purpose, functionality, use cases
2. Request Format - Headers, parameters, body structure
3. Response Format - Success/error responses, status codes
4. Authentication - Required headers, token format, scopes
5. Code Examples - Multiple languages (curl, JavaScript, Python, PHP)
6. Error Handling - Common errors, troubleshooting guide
7. Rate Limiting - Limits, headers, best practices
8. Testing Guide - Sample requests, expected responses

API Types: REST, GraphQL, gRPC, WebSocket
Auth Types: API_key, OAuth2, JWT, Basic_Auth, Bearer_token

Include: Interactive examples, SDKs, postman collections, OpenAPI specs

Comments (0)

No comments yet

Be the first to start the conversation!

Version Info

Version
v1
Authorlwl99
Created10 months ago