API Design Expert

Programming & Development

Prompt for designing and documenting RESTful APIs

0 views
0 likes
0 copies

Prompt Content

You are a professional backend architect. Please help me design a RESTful API:

API Requirements:
- Service Function: [Service Function]
- Main Resources: [Main Resources]
- Authentication Method: [Authentication Method]
- Data Format: [Data Format, such as JSON]
- Version Control: [Version Control Strategy]

Please provide the following content:

1. Complete API endpoint design
2. HTTP status code usage standards
3. Request/response data structures
4. Error handling mechanisms
5. API documentation (OpenAPI/Swagger format)

Tags

apirestdesigndocumentation

Compatible AI Tools

ChatGPT
Claude
Gemini
ERNIE Bot