Next.js API Route Documenter skill for Claude and Codex
Produces a copy-ready Markdown reference for one Next.js API route: method, URL, parameters, request and response bodies, auth, and error codes, in the shape…
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 one Next.js API endpoint needs a README or wiki reference with its method, URL, parameters, bodies, auth, and error codes. Do not use for generating the route's code or an OpenAPI file for a whole API. Related topics: coding, next.js.
What it will ask you for
- Route path (free text, e.g. "/api/users")
- HTTP method (choose one: GET, POST, PUT, DELETE, PATCH)
- Description (longer free text)
- Query parameters (longer free text)
- Request body schema (longer free text)
- Response schema (longer free text)
- Authentication required (choose one: Yes, No)
How it works
- Write the Overview from the description so a caller knows what the endpoint does and when to use it.
- State Method and URL and build the Parameters table with name, type, required, and description, or write None.
- Render the request and response as fenced JSON examples with realistic values and list each field's meaning.
- Describe the credential and how it is sent under Authentication, or mark the route public.
- List the status codes the route can return with their meaning and output the sections in the fixed order as plain Markdown.
What you get
Plain Markdown (not wrapped in an outer fence) with sections in this order: Overview, Method, URL, Parameters table, Request Body, Response, Authentication, Errors.
What it watches out for
- Filling the JSON examples with placeholder words like string and number, which tells the caller nothing about real values.
- Omitting the 405 and 401 cases, which are the first errors a new caller hits.
- Documenting what the route should do rather than what the description says it does.
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.