api-design

REST conventions, Zod validation, and consistent error formats.

Skill by YepAPI

IndexedMIT★ 8

Install

Works with Claude Code, Claude apps, Codex, Cursor, Gemini CLI, GitHub Copilot, VS Code, OpenCode, Goose, Windsurf. Read the repository before you give any tool access to your data.

npx agentmarket install skill/yepapi-api-design

Asks which of your tools to add it to (Claude Code, Codex, Cursor, VS Code, Windsurf, Gemini CLI, Claude Desktop) and shows the change first. See https://agentmart.dev/cli.

Get the weekly diff

The weekly diff: one email a week with new agent tools, notable updates and grade changes, plus security alerts for tools you follow. Double opt-in, one-click unsubscribe.

About

REST conventions, Zod validation, and consistent error formats.

Use cases: design, backend

Reviews

Write a review

No reviews yet. Installed it? Reviews come from verified installers only. How reviews work

Permissions

What this skill can do and what it asks for, from its SKILL.md. Checked Oct 25, 2026.

Tools: No tools found
Secrets: None asked for
Install scripts: None found

Network hosts it talks to 1

codeload.github.com · found in install command

Files it touches

~/.claude/skills/api-design

What's inside

Skill name: api-design
Description: REST conventions, Zod validation, and consistent error formats.
License: MIT
Instructions: 21 lines in SKILL.md · view on GitHub

Files (2)

README.md
SKILL.md

SKILL.md (first lines)

# API Design

## Rules

- RESTful naming: plural nouns, no verbs — `/users`, `/orders`, not `/getUsers`
- HTTP methods: GET (read), POST (create), PATCH (update), DELETE (remove)
- Input validation with Zod: parse request body before processing
- Consistent error format: `{ error: { code: string, message: string } }`
- Pagination: `?limit=20&offset=0` or cursor-based for large datasets
- Status codes: 200 (ok), 201 (created), 400 (bad request), 401 (unauthorized), 404 (not found), 500 (server error)
- Rate limiting: per-key or per-IP, return `429` with `Retry-After` header
- API versioning via URL prefix: `/v1/resource`

## Avoid

- Verbs in URLs: `/getUser/123` — use `GET /users/123`
- Inconsistent error shapes across endpoints
- Returning 200 for errors with `{ success: false }` — use proper HTTP status codes
- Missing input validation — never trust client input

From YepAPI/skills, MIT.

Signals

Stars: 8
Forks: 1
Open issues: 0
Last commit (this folder): Apr 12, 2026 (6 months ago)

From GitHub (fetched Oct 24, 2026).

Details

License: MIT
Repository: github.com/YepAPI/skills
First seen: Oct 24, 2026
Last checked: Oct 24, 2026
Source: GitHub github-graphql

More from YepAPI

Cite this page

api-design skill. Agent Mart. https://agentmart.dev/skills/yepapi-api-design (last updated 2026-10-24)