StructuredFor DevelopersAPI Development & Integrations

REST API Endpoint Specification.

Before building any API endpoint — a spec agreed on before coding prevents integration rework.

ChatGPT · Claude · Gemini·Intermediate·~900 tokens
Curated by the AIPP team
Last updated 14 May 2026 · v3
rest-api-endpoint-specification-4.md · 900 words
You are a senior {{role}} brought in to help a developer or tech professional complete a {{use_case}} task.

# Context
- Pack: Developers & Tech Professionals
- Category: API Development & Integrations
- Use case: REST API Endpoint Specification
- Source task:
  - Write a complete REST API specification for the {{resource_name}} resource. Operations needed: {{list}}. Include for each endpoint: HTTP method + URL path, request parameters (path, query, body) with types and validation rules, response schema (success and error), HTTP status codes, authentication requirement, and a cURL example. Also define the standard error response format used across all endpoints.

# Goal
Complete endpoint specs with request/response schemas, status codes, auth requirements, cURL examples, and a standard error format.

# Constraints
- Produce a complete, usable first draft in one response.
- Avoid generic filler, vague advice, and unsupported claims.
- Make the output specific, practical, and ready to use.

# Output
Complete endpoint specs with request/response schemas, status codes, auth requirements, cURL examples, and a standard error format.

The variables to fill in

PlaceholderWhat to put thereExample
{{role}}RoleAPI design expert
{{use_case}}Your specific valuerest api endpoint specification
{{resource_name}}Resource nameRESOURCE NAME
{{list}}Listauthentication, billing, notifications

How to customize this prompt

  1. Replace each {{double-curly}} with your real context.
  2. Adjust the constraints section to match your tone — formal, casual, blunt.
  3. If the engagement is recurring, change the duration line to mention milestones rather than days.
  4. Run it in your tool of choice. The output should be ready to paste with at most one small edit.

When to use

Before building any API endpoint — a spec agreed on before coding prevents integration rework.

PRO TIP

Write the API spec before writing the implementation — API design is far cheaper to change on paper than in code.

Related prompts

Structured

Blog Post Drafting Engine

Write a complete, SEO-optimised blog post on the given topic. Include a compelling headline, an engaging introduction, 4-5 subheadings with detailed body paragraphs, and a strong conclusion with a cal

Structured

Email Newsletter Writer

Write a complete email newsletter including subject line, preview text, opening hook, main body content (3 short sections), and a clear call to action.

Structured

YouTube Video Script Writer

Write a complete YouTube video script including a strong hook (first 30 seconds), structured main content with transitions, and a closing that encourages likes, comments, and subscriptions.

Structured

LinkedIn Article Builder

Write a complete LinkedIn article that establishes professional authority, shares a genuine insight, and encourages professional discussion.

★ THIS PROMPT IS IN A PACK

The Developer Toolkit Pack

250 technical prompts for code review, documentation, architecture planning, debugging, test writing, API design, and career growth — built by developers for developers.

Browse more prompts →