๐Ÿ”Œ
AI EngineeringPython

API Design

by majiayu000

API Design is an AI Engineering skill for Claude Code, published by majiayu000 in spellbook.

265 stars26 forkson majiayu000/spellbookAdded 2026/09/02+1% in starsRepository updated 2026/08/31
agent-skillsai-agent-skillsai-agentsai-coding-assistantautomationclaudeclaude-codeclaude-code-skillscode-reviewcodexcodex-skillscross-runtimedeveloper-toolsmulti-agentproductivityprompt-engineeringskill-librarysoftware-developmentspellbookworkflows
Install in seconds
Install API Design
Copy API Design into your Claude Code skills folder. Run the command in your terminal, or review the source on GitHub before installing.
terminal
npx degit https://github.com/majiayu000/spellbook/tree/main/skills/api-design ~/.claude/skills/api-design

Requires Node.js. Downloads this skill only โ€” not the rest of the repository โ€” into your Claude Code skills folder.

Without Node.js

git clone https://github.com/majiayu000/spellbook.git

Clones the whole repository, then copy the skillโ€™s own directory into your skills folder yourself.

In this catalog

Source file
skills/api-design/SKILL.md in majiayu000/spellbook
Installs to
~/.claude/skills/api-design
Collection
One of 25 skills cataloged from this repository
Category
AI Engineering โ€” 2631 skills

What API Design does

API Design covers REST, GraphQL, and gRPC best practices for defining contracts, versioning, pagination, errors, and idempotency. Use it when designing public or internal APIs and their schemas.

API Design is cataloged under AI Engineering on DirSkills. API Design comes from a repository tagged agent-skills, ai-agent-skills, ai-agents, ai-coding-assistant and automation.

Documentation

README

API Design

Core Principles

  • Contract-First โ€” Define API spec before implementation
  • OpenAPI 3.2 โ€” Use OpenAPI for REST API documentation
  • URL Versioning โ€” Version in path /v1/, with Sunset headers
  • Idempotency โ€” PUT/DELETE must be idempotent, POST uses Idempotency-Key
  • Cursor Pagination โ€” Avoid offset-based pagination
  • RFC 7807 Errors โ€” Standard Problem Details format
  • No backwards compatibility โ€” Delete, don't deprecate

Quick Reference

When to Use What

This is the opening of the README. Read the full README on GitHub.

Commands API Design provides

Slash commands named in this skillโ€™s SKILL.md, listed in the order they first appear.

  • /users
  • /orders

Frequently asked about API Design

  • What else does majiayu000 publish alongside API Design?

    API Design is one of 25 skills that DirSkills catalogs from majiayu000/spellbook, the repository it ships in. Its siblings there include AGENTS.md Scaffold, Agents Md Optimize and App User Story QA. Each one is a separate skill with its own page in this directory, installs the same way API Design does, and is maintained by majiayu000 in that same repository. The rest of the collection is listed on the majiayu000/spellbook page.

  • How does API Design compare to other AI Engineering skills?

    API Design ranks #2226 by stars among the 2631 AI Engineering skills in this catalog. The most-starred ones next to it are Architecture Decision Records, AI-First Engineering and Agentic OS. DirSkills ranks by the star count of the repository each skill ships in, so that order reflects how popular those repositories are rather than any review of API Design against them. Open each page to compare what they document and how they install.

More from majiayu000/spellbook

API Design is one of 25 skills cataloged on DirSkills from majiayu000/spellbook.

See all 25 skills โ†’
๐Ÿงญ
1h ago

AGENTS.md Scaffold

AGENTS.md Scaffold generates or updates repository-specific AGENTS.md files from repo evidence. It is used when a repo needs scoped agent instructions, validation commands, or directory-specific rules.
Automation
26526
๐Ÿ› ๏ธ
1h ago

Agents Md Optimize

Agents Md Optimize audits a CLAUDE.md or AGENTS.md file, scores common instruction patterns, and applies approved fixes in place. Use it when you want to improve an agent instruction file, not just review it.
AI Engineering
26526
๐Ÿงช
1h ago

App User Story QA

App User Story QA turns a broad request to test an app into a tracked loop of feature inventory, code-backed expected behavior, and user-story tests. Use it to audit every surface, classify failures, and retest documented defects after fixes.
Quality
26526
๐Ÿ—๏ธ
1h ago

Architecture Foundation

Architecture Foundation turns architecture discussions into explicit boundaries, contracts, validation gates, and a small execution plan. Use it when designing or refactoring system structure, choosing module or service boundaries, or writing a spec before coding.
AI Engineering
26526
๐Ÿ—๏ธ
1h ago

Architecture Research

Architecture Research helps analyze real systems from source, docs, and runtime evidence before choosing a technical direction. Use it for architecture studies, system archaeology, build-vs-buy decisions, and reassessing earlier choices.
AI Engineering
26526
๐Ÿค–
1h ago

Ask OpenCLI

Ask OpenCLI sends prompts to Grok or Gemini through the user's logged-in Chrome session. Use it when you want a second opinion without API costs, or when a workflow needs browser-based access to those models.
AI Engineering
26526