Coding
API Documentation Writer
Create clear, developer-friendly API documentation for any API or service, including endpoint details, authentication flow, request and response examples, error handling, parameters, and usage notes. This prompt helps teams produce clean technical documentation that developers can understand and implement quickly.
CodingWriting
Prompt
Create developer-friendly API documentation for [API/service]. Include endpoints, request examples, response examples, and authentication steps.
ChatGPTClaude
Sample Output
# User Authentication API Documentation
Base URL:
https://api.example.com/v1
Authentication:
This API uses Bearer Token Authentication.
Header Example:
Authorization: Bearer YOUR_ACCESS_TOKEN
---
## Login User
Endpoint:
POST /auth/login
Request Body:
{
"email": "[user@example.com](mailto:user@example.com)",
"password": "SecurePassword123"
}
Successful Response:
{
"success": true,
"token": "eyJhbGciOiJIUzI1NiIs...",
"user": {
"id": "u_1024",
"name": "John Doe",
"email": "[user@example.com](mailto:user@example.com)"
}
}
Error Response:
{
"success": false,
"message": "Invalid email or password"
}
---
## Get User Profile
Endpoint:
GET /users/profile
Headers:
Authorization: Bearer YOUR_ACCESS_TOKEN
Successful Response:
{
"success": true,
"data": {
"id": "u_1024",
"name": "John Doe",
"email": "[user@example.com](mailto:user@example.com)",
"role": "admin"
}
}
---
## Refresh Token
Endpoint:
POST /auth/refresh-token
Request Body:
{
"refreshToken": "refresh_token_here"
}
Response:
{
"success": true,
"accessToken": "new_access_token"
}
---
Status Codes:
• 200 → Success
• 400 → Bad Request
• 401 → Unauthorized
• 404 → Resource Not Found
• 500 → Internal Server Error
#programming#ai#ai#productivity
Actions
Open with
