agentleFS
Sign inStart free
HarambeeAIHarambeeAI/bayes-ship/skills/api-design/SKILL.md

api-design

Skill1 starsChanged 7 months agoMITView on GitHub

REST API endpoint design, request/response patterns, versioning, error handling, and authentication patterns. Use during architecture and implementation phases. Source: everything-claude-code.

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

6 rules. 0 are common, 2 are distinctive, and 4 are very specific to this project.

  • 0

    Common

    Most of the 165 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 4

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    No verbs in URLs: /invoices not /getInvoices

    line 12
  2. Very specific:

    Always return the created/updated resource on POST/PATCH/PUT

    line 26
  3. Very specific:

    Use ?page=1&limit=20 for pagination

    line 27
  4. Very specific:

    Use ?status=paid&sort=-created_at for filtering and sorting

    line 28
  5. Distinctive:

    Use Bearer tokens in Authorization header

    line 33
  6. Distinctive:

    Only version when breaking changes are needed

    line 49

“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

URL conventions

  • Nouns for resources: /api/invoices, /api/clients
  • Plural: /invoices not /invoice
  • Nested for relationships: /invoices/:id/line-items
  • No verbs in URLs: /invoices not /getInvoices

HTTP methods

MethodPurposeResponse code
GETRead200
POSTCreate201
PATCHPartial update200
PUTFull replace200
DELETERemove204

Request/response patterns

  • Always return the created/updated resource on POST/PATCH/PUT
  • Use ?page=1&limit=20 for pagination
  • Use ?status=paid&sort=-created_at for filtering and sorting
  • Return { data: [...], meta: { total, page, limit } } for lists

Authentication

  • Use Bearer tokens in Authorization header
  • Public endpoints explicitly marked (no auth middleware)
  • Webhook endpoints validate source (IP whitelist or signature verification)

Error handling

  • 400: Client error (validation, bad input)
  • 401: Not authenticated
  • 403: Not authorized (authenticated but insufficient permissions)
  • 404: Resource not found
  • 409: Conflict (duplicate, state conflict)
  • 500: Server error (never expose internals)

Versioning

  • URL prefix: /api/v1/invoices
  • Only version when breaking changes are needed
  • New fields on existing endpoints are NOT breaking changes

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.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

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