Generate clear API docs with endpoints, examples, and error codes.
#api
#documentation
#developer
#reference
Prompt
Write API documentation for the following endpoint:
Method: [GET/POST/PUT/DELETE]
Path: [/api/v1/resource]
Description: [What it does]
Include:
1. Overview and authentication requirements
2. Request parameters (path, query, body) with types
3. Response schema with example JSON
4. Error codes and meanings
5. cURL and [Language] code examples
Customize
Fill Variables
Details
Model
Claude 3
Category
Development
Added On
Aug 14, 2024
Prompts are starting points. Review outputs before using them in production.