api-design

Design REST, GraphQL, RPC, webhook, and internal service APIs.

IndexedMIT★ 1

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/paishu-ai-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

Design REST, GraphQL, RPC, webhook, and internal service APIs. Use for routes, status codes, request/response schemas, error models, pagination, filtering, versioning, idempotency, and OpenAPI or contract documentation.

Use cases: documents, 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: Design REST, GraphQL, RPC, webhook, and internal service APIs. Use for routes, status codes, request/response schemas, error models, pagination, filtering, versioning, idempotency, and OpenAPI or contract documentation.
License: MIT
Instructions: 35 lines in SKILL.md · view on GitHub

Agent Skills spec issues

name: "api-design" does not match folder "06-api-design"

Files (1)

SKILL.md

SKILL.md (first lines)

# API Design

## Workflow

1. Identify resource, action, caller, authorization boundary, and compatibility needs.
2. Choose API style that matches the existing system.
3. Define request schema, response schema, error schema, and status codes.
4. Define pagination, filtering, sorting, idempotency, rate limits, and versioning when applicable.
5. Add tests or contracts for normal, error, and boundary behavior.

## REST Defaults

- Use HTTP semantics accurately.
- Use safe and idempotent methods correctly.
- Return errors in a consistent problem format; RFC 9457 Problem Details is a good default when no local standard exists.
- Use OpenAPI when the project already documents APIs or when external consumers need a contract.

## Webhook Defaults

- Verify signatures.
- Prevent replay when possible.
- Make processing idempotent.
- Store enough event metadata for audit and replay diagnosis.

## Output

Provide endpoint summary, schema shape, error cases, security notes, and compatibility risks.

## Boundaries

- Do not claim files, generated media, deployments, scans, account changes, or external writes unless the active tool or command output proves them.
- Do not override system, developer, user, project, or selected-skill rules.
- If another skill is more specific for the user's intent, hand off or use it as the main skill instead of duplicating its workflow.

From PAISHU-AI/PAI-zong-NB-v5.8, MIT.

Signals

Stars: 1
Forks: 1
Open issues: 0
Last commit (this folder): Jul 18, 2026 (3 months ago)

From GitHub (fetched Oct 24, 2026).

Details

License: MIT
Repository: github.com/PAISHU-AI/PAI-zong-NB-v5.8
First seen: Oct 24, 2026
Last checked: Oct 24, 2026
Source: GitHub github-graphql

More from PAISHU-AI

Cite this page

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