Backend API Design
Use when the user asks about REST API design, designing REST endpoints, URL and resource naming, HTTP methods and status codes, pagination, filtering or error formats. Produces endpoint contracts with conventions. Not for the response envelope (use backend-api-response) or versioning (use backend-api-versioning).
Install
npx skills add j4flmao/agent-skills --skill backend-api-designgit clone --depth 1 https://github.com/j4flmao/agent-skills.git /tmp/agent-skills
mkdir -p ~/.claude/skills
cp -r /tmp/agent-skills/skills/backend/universal/api-design ~/.claude/skills/backend-api-designPersonal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.
From the SKILL.md
# Backend API Design
## Purpose
Design consistent, production-grade REST or GraphQL APIs. Every endpoint must follow the same conventions for URLs, requests, responses, errors, and pagination.
## Agent Protocol
### Trigger
Exact user phrases: "API design", "REST API", "GraphQL schema", "endpoint design", "API conventions", "URL structure", "HTTP methods", "response format", "API versioning", "pagination", "design an endpoint", "API contract".
### Input Context
Before activating, verify:
- The resource or feature being designed is known.
- The tech-spec for the feature exists or the user has described the resource.
- The chosen API style (REST/GraphQL) is known. If not, ask: "REST or GraphQL?"
### Output Artifact
No file output unless the user requests it. Produces endpoint specifications as text.
### Response Format
For each endpoint:
```
{method} {path}
Auth: {required/optional/none}
Request: {schema reference}
Response 2xx: {schema reference}
Errors: {list of error codes}
```
For a full API design, group by resource:
```
## {resource}
{list of endpoints}
```
No preamble. No postamble. No explanations. No filler/hedging/transitions. Compress output. No explanations of REST principles.
### Completion Criteria
- [ ] All resources follow the naming conventions below.
- [ ] Every endpoint has: method, path, auth requirement, request schema, response schema, error codes.
- [ ] List endpoints are paginated.
- [ ] Response envelope is consistent across all endpoints.Details
- Skill name
backend-api-design- Repository
- j4flmao/agent-skills
- Path
skills/backend/universal/api-design/SKILL.md- License
- MIT
- Repo updated
- 17 November 2026
FAQ
What does the Backend API Design skill do?
Use when the user asks about REST API design, designing REST endpoints, URL and resource naming, HTTP methods and status codes, pagination, filtering or error formats. Produces endpoint contracts with conventions. Not for the response envelope (use backend-api-response) or versioning (use backend-api-versioning).
How do I install the Backend API Design skill?
skills CLI (Claude Code, Cursor, Codex and more): npx skills add j4flmao/agent-skills --skill backend-api-design. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.
Is Backend API Design popular?
It lives in j4flmao/agent-skills, which has 45 GitHub stars and 6 forks.
Related skills
Agent Observability
45j4flmao/agent-skills
Use when the user asks about agent observability, tracing agent reasoning, debugging an agent loop, OpenTelemetry GenAI spans for LLM calls, LLM cost tracking per agent, agent audit logs or hallucination/eval monitoring in production. Produces instrumentation config, trace schema, dashboards, alerts and cost attribution. Not for generic service tracing without LLMs (use devops-opentelemetry).
AI Agent Architectures
45j4flmao/agent-skills
Use when the user asks to build an AI agent, design an agent that calls tools and keeps memory, write an agent system prompt or pick an agent framework (Claude Agent SDK, OpenAI Agents SDK, LangGraph). Produces an architecture brief covering loop, tools, memory, guardrails and evals, routing depth to child skills. Not for workflow patterns (use ai-agentic-workflows).
AI Agent Core Loop
45j4flmao/agent-skills
Use when the user asks about the agent loop, ReAct vs plan-and-solve, re-planning, Reflexion, an agent stuck in a loop, max iterations or termination conditions. Produces a loop spec or patch with state, success predicate, caps and no-progress detection. Not for overall agent design (use ai-agent-architectures) or tool schemas (use tool-calling-principles).
Backend API Response
45j4flmao/agent-skills
Use when the user asks about API response format, ApiResponse<T> envelope, error codes, Problem Details (RFC 9457), validation error responses or pagination envelopes. Produces a uniform success/error response contract. Not for endpoint and URL design (use backend-api-design).
Authoritative Server
45j4flmao/agent-skills
Use when the user asks about an authoritative game server, dedicated server, server tick loop, snapshots, input authority, server reconciliation, rollback or lag compensation on the server. Produces tick loop and world-state design. Not for client-side prediction (use multiplayer-netcode) or fleet scaling (use scaling-architecture).
Backend API Versioning
45j4flmao/agent-skills
Use when the user asks about API versioning, URI vs header versioning, breaking changes, deprecating or sunsetting an endpoint, Deprecation and Sunset headers or API migration. Produces a versioning and deprecation plan. Not for API product strategy (use api-product-management).
Browse the most popular Claude skills, all software development skills, or write your own with the skills generator.