REST API Endpoint Designer skill for Claude and Codex
A full endpoint contract before anyone writes a handler: route and method, validated request shape, success and error responses with the right status codes…
Install it once and Claude or Codex runs it for you. When your request matches, your AI loads the skill, asks for anything it is missing, and works through the template itself. Prefer to fill it in by hand? See the full prompt template.
Download the skill (.zip) · View SKILL.md
When it is used
Use when a new REST endpoint needs its contract specified (route, request schema, validation, status codes, error bodies) before implementation starts. Do not use for GraphQL schemas, reviewing an existing API's performance, or writing the server code. Related topics: coding, api, rest.
What it will ask you for
- Resource name (free text, e.g. "orders")
- HTTP method (choose one: GET, POST, PUT, PATCH, DELETE)
- Endpoint path (free text, e.g. "/api/v1/orders/:id")
- Authentication required (choose one: Yes, No)
- Query parameters (longer free text)
- Request body fields (longer free text)
- Validation rules (longer free text)
- Success response body (longer free text)
- Error cases to cover (choose any: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 422 Validation Error, 500 Server Error)
- Include OpenAPI definition (choose one: Yes, No)
How it works
- Confirm the method matches REST semantics for the operation and set the success status code accordingly (200, 201, or 204).
- Write the request schema with types, required fields, and each validation rule attached to the field it governs.
- Define the success response with an example payload, adding pagination parameters and an envelope for list endpoints.
- Give every selected error the same body shape with a code, message, and details, and state what triggers each.
- When requested, write the OpenAPI 3.1 path item in YAML with schemas under components and referenced from the path.
What you get
Sections for Endpoint, Request, and Responses in that order, with example payloads, followed by an OpenAPI 3.1 YAML code block when requested.
What it watches out for
- Returning 200 for a create, which hides the new resource's location and breaks clients that expect 201.
- Putting a request body on a GET or DELETE, which many proxies and clients drop silently.
- Using a different error body shape per status code, so every client has to special-case the parsing.
How to install
Claude.ai and the Claude desktop app
- Download the skill .zip.
- Open Settings, then Capabilities, and find Skills.
- Choose Upload skill and select the .zip.
- Ask Claude for help with the task. It loads the skill when your request matches.
Claude Code
- Download the skill .zip.
- Unzip it into ~/.claude/skills/ (or .claude/skills/ inside a project).
- Start a new session. Claude Code loads the skill when your request matches.
Codex
- Download the skill .zip.
- Unzip it into ~/.agents/skills/ (or .agents/skills/ inside a project).
- Codex picks it up on its own. Type $ and the skill name to use it, or just ask for the task.
Cursor
- Download the Cursor rule (.mdc).
- Save it in .cursor/rules/ inside your project.
- Cursor's agent applies the rule when your request matches its description.
AGENTS.md (Codex, Cursor, and other coding agents)
- Copy the AGENTS.md section.
- Paste it into AGENTS.md at the root of your repository, creating the file if needed.
- Coding agents that read AGENTS.md follow it when your request fits.