Agent skill · Backend & API

api-design-skill

REST/GraphQL API design patterns - resource naming, HTTP methods, error handling, pagination, versioning. Use when: design API, REST endpoints, GraphQL schema, error responses, pagination, rate limiting, API documentation.

majiayu000github.com/majiayu000GitHub ↗
claude-codeMIT
Install
npx skills add majiayu000/claude-skill-registry --skill api-design-skill --agent claude-code

Same command for any agent — swap --agent for codex, cursor, copilot.

Facts
Files in the skill folder: 2
SKILL.md size: 12 KB
Bundled scripts: none
Path: skills/api/api-design-skill/SKILL.md
Open the folder on GitHub →
Where it comes from
Stars: 534
Language: HTML

Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.

From the SKILL.md

<objective> Comprehensive API design skill covering RESTful conventions, error handling, pagination, versioning, and documentation. Focuses on building consistent, intuitive, and maintainable APIs. Good API design makes the right thing easy and the wrong thing hard. This skill helps you create APIs that are a pleasure to use and maintain. </objective> <core_principles> ## API Design Principles 1. **Consistency** - Same patterns everywhere (naming, errors, pagination) 2. **Predictability** - Developers can guess how things work 3. **Simplicity** - Easy cases should be easy, complex cases possible 4. **Backwards compatibility** - Don't break existing clients 5. **Self-documenting** - Clear naming, helpful error messages </core_principles> <rest_basics> ## RESTful Conventions ### Resource Naming ``` # GOOD: Nouns, plural, lowercase, hyphenated GET /users GET /users/{id} GET /users/{id}/posts GET /blog-posts GET /api/v1/user-preferences # BAD: Verbs, singular, mixed case, underscores GET /getUser GET /user/{id} GET /User/{id}/getPosts GET /blog_posts ``` ### HTTP Methods | Method | Purpose | Idempotent | Safe | Request Body | |--------|---------|------------|------|--------------| | GE

What's inside
Steps it walks through
  1. API Design Principles
  2. RESTful Conventions
  3. Resource Naming
  4. HTTP Methods
  5. CRUD Operations
  6. Actions (Non-CRUD Operations)
  7. Status Codes
  8. Error Responses
  9. Consistent Error Format
  10. Examples
  11. Implementation
  12. Pagination
  13. Cursor-Based (Recommended)
  14. Offset-Based
Ships with 1 file
  • metadata.json
More from claude-skill-registry
All skills →
About this skill
What does the api-design-skill skill do?

REST/GraphQL API design patterns - resource naming, HTTP methods, error handling, pagination, versioning. Use when: design API, REST endpoints, GraphQL schema, error responses, pagination, rate limiting, API documentation.

How do I install it?

Run `npx skills add majiayu000/claude-skill-registry --skill api-design-skill --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.

Where does this skill come from?

From majiayu000/claude-skill-registry, a repository with 534 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.

Is a popular skill a good skill?

Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.

Keep going