Skip to main content
skill Claude Code CX Codex Cursor GitHub Copilot

api-design-principles · sickn33 — Claude Code skill: REST and GraphQL

Skill for designing REST and GraphQL APIs from scratch: architecture, versioning, error handling, and authentication that make APIs pleasant for other developers to consume.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add sickn33/agentic-awesome-skills --skill api-design-principles -a claude-code
Open on GitHub

What api-design-principles does

The skill walks you through API design before you code: define consumers and constraints, choose between REST or GraphQL, model resources or types, specify error strategies, versioning, pagination, and auth. You work through it in conversation with an agent.

Inside: a four-step process and resources/implementation-playbook.md with patterns, checklists, and templates. Runs on Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, and OpenCode.

Use it when designing a new API, refactoring an existing one for developer experience, setting team standards, or preparing a spec for review. Skip it if you need implementation guidance for a specific framework or if you cannot modify public interfaces.

What it helps with

  • design a REST API with versioning and error handling
  • decide between REST and GraphQL for your use case
  • structure resources and data types consistently
  • establish API standards across a team
  • prepare APIs for third-party integrations

Example prompts for the agent

  • Design a REST API for a mobile app with offline sync
  • Rethink our GraphQL schema: how do we handle pagination for large datasets?
  • Create API documentation with error examples and rate limiting

How to install api-design-principles

1Skills CLI (Vercel)

npx skills add sickn33/agentic-awesome-skills --skill api-design-principles -a claude-code

2Manually: put the files in place

~/.claude/skills/api-design-principles/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/api-design-principles/

From the same set80

The whole set →
docker-expert sickn33 A skill that turns your AI agent into a Docker reviewer for Dockerfiles, multi-stage builds and container security. Useful when images and Compose files need a second look. Claude Code CX Codex Cursor +1 27,200installs typescript-expert sickn33 A skill for TypeScript and JavaScript work: it reads your project setup, fixes type errors and speeds up type checking. Useful once a TS codebase gets big. Claude Code CX Codex Cursor +1 12,600installs browser-automation sickn33 This skill builds browser checks around observed UI state and explicit outcomes. Use it for UI workflows, timing failures, or authorised page-data collection. Claude Code CX Codex Cursor +1 6,700installs nextjs-supabase-auth sickn33 This skill wires Supabase Auth into the Next.js App Router with clients, middleware, OAuth callbacks, and Server Actions. Use it when you need protected routes and session handling. Claude Code CX Codex Cursor +1 6,500installs 3d-web-experience sickn33 Helps build and debug web 3D scenes, product configurators, and portfolios. Covers stack choice, model loading, scroll interaction, and performance checks. Claude Code CX Codex Cursor +1 5,200installs prisma-expert sickn33 This skill helps inspect Prisma schemas, migrations, and queries. Use it to investigate an error or review database changes before deployment. Claude Code CX Codex Cursor +1 4,200installs playwright-skill sickn33 Write and run Playwright browser tests directly in Claude Code: responsive design checks, login flows, form submissions, screenshots. Executes locally via Node with a visible browser window. Claude Code CX Codex Cursor +1 3,900installs game-development sickn33 Guides game architecture decisions, platform choices, and core loop structure. Directs the assistant to specialized sub-skills for web, mobile, PC, or VR. Claude Code CX Codex Cursor +1 3,800installs

Other versions of api-design-principles

Similar

node mcollina Gives an agent Node.js and TypeScript guidance, from running .ts files directly to streams, tests and graceful shutdown. Claude Code CX Codex Cursor +1 5,900installs salesforce-flow-design official github Reviews Salesforce Flow architecture, type selection, bulk safety, and fault handling. Use it before designing, reviewing, or activating a Flow. GitHub Copilot 839installs text-to-speech elevenlabs Turns text into speech with ElevenLabs. Use it for voiceovers, audio output, or speech features in an application. Claude Code CX Codex Cursor +1 16,600installs wp-performance WordPress Backend profiling skill for optimizing WordPress sites using WP-CLI, REST headers, and diagnostic scripts without browser access. Claude Code CX Codex Cursor +1 6,100installs ddd-aggregate ruvnet Scaffolds a DDD aggregate root with an entity, value objects, a repository interface, domain events, and test stubs. Useful when modeling business logic in an existing bounded context. Claude Code CX Codex Cursor +1 749installs mcp-builder official anthropics This skill walks through building an MCP server in TypeScript or Python, from reading the protocol spec to writing tests and evaluation questions. Claude Code Claude.ai 130,949installs google-agents-cli-adk-code official Google A reference skill for building ADK agents with tools, callbacks, state, and workflows. Use it when an agent project needs concrete API patterns or code examples. Claude Code CX Codex Cursor +1 511,400installs lark-im larksuite This skill lets an agent work with Lark IM messages, chats, files, and interactive cards. Use it when coding tasks need access to team conversations. Claude Code CX Codex Cursor +1 472,300installs

Questions about api-design-principles

How do I install api-design-principles in Claude Code?

Run npx skills add sickn33/agentic-awesome-skills --skill api-design-principles -a claude-code, then find the installed skill at ~/.claude/skills/api-design-principles/SKILL.md.

What does this skill do?

It helps you design a REST or GraphQL API: define consumers, choose an architecture, specify error handling, versioning, pagination, and auth strategy. Works as a conversation with an agent, pulling from built-in patterns and templates.

When should I skip this skill?

If you need implementation help for a specific framework (Django, FastAPI, Express), if the task is infrastructure-only without API contracts, or if you cannot change your public interfaces.

Source text

SKILL.md · MIT
---
name: api-design-principles
description: "Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time."
risk: safe
source: community
date_added: "2026-02-27"
---

# API Design Principles

Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.

## Use this skill when

- Designing new REST or GraphQL APIs
- Refactoring existing APIs for better usability
- Establishing API design standards for your team
- Reviewing API specifications before implementation
- Migrating between API paradigms (REST to GraphQL, etc.)
- Creating developer-friendly API documentation
- Optimizing APIs for specific use cases (mobile, third-party integrations)

## Do not use this skill when

- You only need implementation guidance for a specific framework
- You are doing infrastructure-only work without API contracts
- You cannot change or version public interfaces

## Instructions

1. Define consumers, use cases, and constraints.
2. Choose API style and model resources or types.
3. Specify errors, versioning, pagination, and auth strategy.
4. Validate with examples and review for consistency.

Refer to `resources/implementation-playbook.md` for detailed patterns, checklists, and templates.

## Resources

- `resources/implementation-playbook.md` for detailed patterns, checklists, and templates.

## Limitations
- Use this skill only when the task clearly matches the scope described above.
- Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
- Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.

© sickn33 · MIT · sickn33/agentic-awesome-skills

See also

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor