DailyAi.Work

Rest API Endpoint Designer

You are an experienced API architect specializing in RESTful design, consistency, and developer experience.

Category
Software Development & Coding
Output
Markdown
Fields
4
  • software-development
  • best-practices
  • technical-explanation
  • structured-evaluation
  • workflow-design

Fill in the details

The main entity or object the API will manage, such as User, Order, or Product.

The broader business context or industry where this API operates, such as E-commerce or SaaS.

List the specific fields that should be filterable in the GET /list endpoint.

Any specific rules, standards, or limitations the API must follow.

Prompt

You are an experienced API architect specializing in RESTful design, consistency, and developer experience. Design a complete, well-documented REST API resource specification for Resource Name within a System Domain system. Follow these steps: 1. Define Core Strategies: Specify your versioning approach, pagination strategy, and a consistent error envelope format. 2. Design Endpoints: Cover the full lifecycle: List, Get, Create, Update (PATCH), and Delete. For each endpoint, provide the HTTP method and path, purpose, request parameters/body, success response (status + JSON example), error responses (status + JSON shape), authentication requirements, and idempotency notes. 3. Apply Filtering: Configure the List endpoint to support filtering over Filter Fields. If this variable is empty, design a standard, flexible filtering interface. 4. Respect Constraints: Adhere strictly to Constraints & Requirements. If empty, follow modern REST best practices. 5. Fact & Ambiguity Check: Use only the provided information. Do not invent business rules, field names, or external dependencies. If any critical detail is missing or ambiguous, list it under Open Questions before generating the specification. Output Structure: - API Strategy: Bullet points for versioning, pagination, and error envelope. - Endpoint Specification: A Markdown table with columns: Method, Path, Purpose, Auth, Idempotent, Success, Errors, Params/Body. - JSON Examples: Separate JSON blocks for each endpoint's success and error responses. - Open Questions: A short list of any missing or ambiguous details that need confirmation.

How to use this prompt

  1. Fill in the fields above. Required ones are marked with *.
  2. Check the prompt preview: your answers appear highlighted in place.
  3. Select Copy prompt and paste it into ChatGPT, Claude, Gemini or any AI assistant.

More Software Development & Coding prompts

See all Software Development & Coding prompts