Skill

api-design

Design REST or GraphQL API endpoints with request/response schemas, validation, auth, and error handling

Install

npx claudepluginhub silviaare95/xari-plugins --plugin backend-dev

Tool Access

This skill uses the workspace's default tool permissions.

SKILL.md

Similar Skills

payload

11 files

Guides Payload CMS config (payload.config.ts), collections, fields, hooks, access control, APIs. Debugs validation errors, security, relationships, queries, transactions, hook behavior.

payload

41.6k

data-engineer

Designs scalable batch/streaming data pipelines, warehouses, lakehouses using Spark, dbt, Airflow, Kafka/Flink, and cloud platforms like Snowflake, BigQuery, Databricks.

antigravity-bundle-data-engineering

31.8k

airflow-dag-patterns

1 file

Builds production Apache Airflow DAGs using best practices for operators, sensors, testing, and deployment. For data pipelines, workflow orchestration, and batch jobs.

antigravity-bundle-data-engineering

31.8k

Stats

Parent Repo Stars0

Parent Repo Forks0

Last CommitApr 8, 2026

Actions

View Source View Plugin View on GitHub View README

Steps

Identify resources — What entities does this API manage? Map out the nouns.

Define endpoints — For each resource:

HTTP method + path (REST) or queries/mutations (GraphQL)
Request body / query params with types
Response shape with types
Auth requirements (public, authenticated, role-based)

Validation rules — Define Zod schemas for request validation:

Required vs optional fields
Type constraints (string length, number ranges, enums)
Cross-field validation

Error responses — Define the error contract:

Consistent error shape across all endpoints
Proper HTTP status codes
Machine-readable error codes + human-readable messages

Write implementation skeleton — Produce the actual route handler code with:

Zod validation
Auth check
Business logic placeholder
Error handling
Response typing

Output Format

For each endpoint, produce:

## <METHOD> <path> **Auth**: <public | authenticated | admin> **Description**: <what it does> ### Request | Field | Type | Required | Validation | |-------|------|----------|------------| | ... | ... | ... | ... | ### Response (200) ```json { "shape": "example" }

Errors

Status

Code

When

400

VALIDATION_ERROR

Invalid input

401

UNAUTHORIZED

Missing/invalid token

404

NOT_FOUND

Resource doesn't exist

Then produce the implementation code (TypeScript, Next.js App Router by default). ## Constraints - Use Zod for all request validation - Always return proper HTTP status codes - Never expose internal error details to clients - Use consistent error response shape across all endpoints - Prefer pagination for list endpoints (cursor-based over offset)

API Design

Design the API for: $0

Style: $1 (default: REST)

Steps

Identify resources — What entities does this API manage? Map out the nouns.
Define endpoints — For each resource:
- HTTP method + path (REST) or queries/mutations (GraphQL)
- Request body / query params with types
- Response shape with types
- Auth requirements (public, authenticated, role-based)
Validation rules — Define Zod schemas for request validation:
- Required vs optional fields
- Type constraints (string length, number ranges, enums)
- Cross-field validation
Error responses — Define the error contract:
- Consistent error shape across all endpoints
- Proper HTTP status codes
- Machine-readable error codes + human-readable messages
Write implementation skeleton — Produce the actual route handler code with:
- Zod validation
- Auth check
- Business logic placeholder
- Error handling
- Response typing

Output Format

For each endpoint, produce:

## <METHOD> <path>

**Auth**: <public | authenticated | admin>
**Description**: <what it does>

### Request
| Field | Type | Required | Validation |
|-------|------|----------|------------|
| ...   | ...  | ...      | ...        |

### Response (200)
```json
{ "shape": "example" }

Errors

Status	Code	When
400	VALIDATION_ERROR	Invalid input
401	UNAUTHORIZED	Missing/invalid token
404	NOT_FOUND	Resource doesn't exist


Then produce the implementation code (TypeScript, Next.js App Router by default).

## Constraints

- Use Zod for all request validation
- Always return proper HTTP status codes
- Never expose internal error details to clients
- Use consistent error response shape across all endpoints
- Prefer pagination for list endpoints (cursor-based over offset)