API Endpoint Designer

Designs a full REST API endpoint spec with request, response, auth, and error schemas.

#api #rest #design #backend #openapi
API Endpoint DesignerPublic Template

Output

Design a REST API endpoint for the following requirement.

API purpose: [api_purpose] Framework / language: [framework] Authentication method: [auth_method] Resource name: [resource_name]

For each endpoint needed:

  1. Method and URL path
  2. Path and query parameters (with types and descriptions)
  3. Request body schema (JSON)
  4. Success response schema (JSON) with HTTP status
  5. Error response schemas (400, 401, 403, 404, 422, 500)
  6. Rate limiting and pagination approach (if applicable)
  7. Example curl request and response

Follow RESTful conventions. Use snake_case for JSON keys.

Variables

0 / 512

0 / 128

0 / 128

0 / 128