$pwd:

api-design

Name: Api Design
Author: neokn

// Design RESTful APIs with best practices. Use when creating new endpoints, designing API contracts, or reviewing API structures.

$ git log --oneline --stat

stars:0

forks:0

updated:December 15, 2025 at 00:27

SKILL.md

readonly

package.json

"author": "neokn"

"repository": "neokn/dotClaude"

$ git clone

$ download --local

[HINT] SKILL.md 및 모든 관련 파일을 포함한 전체 스킬 디렉토리를 다운로드합니다

related-imports.ts

// 관련 스킬

import api-design-framework

from "ArieGoldkin"

import restapi

from "Lobbi-Docs"

import rest-api-design

from "pluginagentmarketplace"

import frontend-implementation

from "jpicklyk"

111

import frontend-storyboard-artist

from "shredbx"

import backend-guide

from "pluginagentmarketplace"

import developer-experience

from "pluginagentmarketplace"

import architecture-navigator

from "ArieGoldkin"

import api-documentation

from "CuriousLearner"

import api-documentation-writer

from "OneWave-AI"

import react-patterns

from "majesticlabs-dev"

import api-designer

from "AutumnsGrove"

API Design Skill

Help design consistent, well-structured RESTful APIs.

Principles

URL Structure

Use nouns for resources: /users, /orders

Use plural forms: /users not /user

Nest for relationships: /users/{id}/orders

Keep URLs shallow (max 2-3 levels)

HTTP Methods

GET: Read (idempotent, cacheable)

POST: Create

PUT: Full update (idempotent)

PATCH: Partial update

DELETE: Remove (idempotent)

Status Codes

200: Success

201: Created

204: No Content (successful DELETE)

400: Bad Request (client error)

401: Unauthorized

403: Forbidden

404: Not Found

409: Conflict

422: Unprocessable Entity (validation)

500: Server Error

Response Format

{ "data": { ... }, "meta": { "page": 1, "total": 100 }, "errors": [ { "field": "email", "message": "Invalid format" } ] }

Pagination

Use cursor-based for large datasets

Use offset-based for simple cases

Always include: page, per_page, total, next_cursor

Versioning

URL prefix: /v1/users

Header: Accept: application/vnd.api+json; version=1

Checklist for New Endpoints

name	api-design
description	Design RESTful APIs with best practices. Use when creating new endpoints, designing API contracts, or reviewing API structures.
allowed-tools	Read, Write, Edit, Grep, Glob

API Design Skill

Help design consistent, well-structured RESTful APIs.

Principles

URL Structure

Use nouns for resources: /users, /orders
Use plural forms: /users not /user
Nest for relationships: /users/{id}/orders
Keep URLs shallow (max 2-3 levels)

HTTP Methods

GET: Read (idempotent, cacheable)
POST: Create
PUT: Full update (idempotent)
PATCH: Partial update
DELETE: Remove (idempotent)

Status Codes

200: Success
201: Created
204: No Content (successful DELETE)
400: Bad Request (client error)
401: Unauthorized
403: Forbidden
404: Not Found
409: Conflict
422: Unprocessable Entity (validation)
500: Server Error

Response Format

{
  "data": { ... },
  "meta": {
    "page": 1,
    "total": 100
  },
  "errors": [
    { "field": "email", "message": "Invalid format" }
  ]
}