agentleFS
Sign inStart free
kuker24kuker24/OpenCodeBestFriend/skills/api-design/SKILL.md

api-design

Skill0 starsChanged 2 months agoMITView on GitHub

Design or review REST API contracts — resource naming, HTTP methods, status codes, pagination, filtering, errors, versioning, and rate-limit headers. Use when shaping or auditing HTTP endpoints. Not for library/API docs (research/Context7), consumer-provider schema ownership (contract-first), or auth/secrets review (full-audit-keamanan).

191 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use db-design, everything-claude-code and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • yuexueyuSkill

    db-design

    数据库工程师技能 - Schema设计、索引优化、并发安全、数据库审计。当你涉及数据库表/字段/索引/SQL/迁移/MCP数据库操作、建表改表、写查询时必须使用此技能。即使用户只是说"加个字段"或"查下数据"，也应触发。

    Also in 4 projects that use this

  • InfopibeSkill

    everything-claude-code

    Also in 9 projects that use this

  • mryeastcodeSkill

    everything-claude-code-conventions

    Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.

    Also in 8 projects that use this

  • tpavanipradeepSkill

    nextjs-turbopack

    Next.js 16+ and Turbopack — incremental bundling, FS caching, dev speed, and when to use Turbopack vs webpack.

    Also in 15 projects that use this

  • Indium-AI-LabsSkill

    data-pipeline-design

    Design batch or incremental ETL and ELT pipelines and warehouse models: grain, partitioning, idempotent loads, late-arriving data, data quality tests, PII controls, and cost monitoring, before building them. Use when adding or changing a dbt model, warehouse table, scheduled transformation, or ingestion job. Not for transactional schema design (use the database-design skill) or event-sourced stores (use the event-sourcing-architecture skill).

    Also in 3 projects that use this

  • thejordanleopoldSkill

    third-party-integration

    Use when integrating with external APIs, payment processors (Stripe), webhooks, or third-party services. Use when implementing API clients with authentication and rate limiting, handling webhooks with signature verification and idempotency, writing contract tests for external services, or isolating third-party dependencies behind adapters. Triggers: \"Stripe\", \"payment integration\", \"webhook\", \"third-party API\", \"external service\", \"API client\", \"integrate with\", \"signature verification\", \"idempotency key\".

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

1 rule. 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 165 edited versions we read keep these.

  • 1

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Do not dump framework tutorials.

    line 33

“Common” is measured: kept by at least 6 in 10 of the 165 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

API Design

First-party REST design specialist. Shape the public HTTP surface so clients can predict resources, status, errors, and pagination without guessing.

Boundaries & Handoffs

NeedRoute
Official library or framework docsresearch / Context7
One canonical OpenAPI/AsyncAPI/Protobuf artifact shared by consumers and providerscontract-first
Auth, secrets, public API attack surfacefull-audit-keamanan
Module seams and testability inside one codebasecodebase-design
REST resource, status, pagination, error, and versioning designapi-design

Procedure

Consult references/conventions.md for the checklist.

  1. Name the resource. Nouns, plural, lowercase kebab-case. Nest only for true ownership. Verbs belong on actions that are not CRUD (POST /orders/:id/cancel).
  2. Pick the method and status. GET/PUT/DELETE are idempotent. POST creates or triggers. Do not wrap failures in 200 with "success": false.
  3. Lock the envelope. One success shape and one error shape for the API. Collections carry pagination meta. Errors carry a stable code, a message, and field details when validation fails.
  4. Paginate lists. Offset for small admin/search pages. Cursor for feeds and public lists. State which one, and why.
  5. Filter and sort as query params. Equality, bracket comparators, comma-separated multi-values. Do not invent a second RPC style beside REST.
  6. Version only on breaking changes. Path /api/v1 is the default. Additive fields do not need a new version. Breaking changes need a deprecation window.

Do not dump framework tutorials. Implement in the project's existing stack.

Output

Return a contract sketch: paths, methods, status codes, request/response fields, pagination choice, and breaking vs additive notes. Point contract-first at the artifact if more than one consumer will implement against it.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free