REST API Endpoint Designer
By Alex Brown · Published · Updated
Design RESTful API endpoints with request/response schemas and status codes.
Tags: coding, api, rest
Prompt template
## Introduction Design a complete RESTful API endpoint including route, method, request body, and response schemas. ## API Details - Resource Name: [text: e.g., users, products, orders] - HTTP Method: [dropdown: GET, POST, PUT, PATCH, DELETE] - Endpoint Path: [text: e.g., /api/v1/users/:id] - Authentication Required: [toggle: Yes, No] ## Request Details - Query Parameters: [textarea: List any query parameters and their types] - Request Body Schema: [textarea: Describe the request body fields] - Validation Rules: [textarea: e.g., email must be valid, price > 0] ## Response Details - Success Response (200/201): [textarea: Describe the response body] - Error Scenarios: [multi: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 422 Validation Error, 500 Server Error] - Include OpenAPI / Swagger definition: [toggle: Yes, No]