API Conventions
Interne REST-regler Claude anvender ved design af endpoints: URL-form, data/error/meta, 422
Testet · Virker
Hvad det gør
En reference-skill, der indlæser et fast sæt REST-konventioner, når Claude skriver eller gennemgår API-endpoints: plural kebab-case ressource-URL'er med maks. to indlejringsniveauer, en obligatorisk data/error/meta response-envelope, en statuskode-tabel, der dirigerer forretningslogik-fejl til 422, Bearer-autentificering med en @public opt-out og /api/v1 path-versionering. Den udløses ved anmodninger om at designe et nyt endpoint, vælge et response-format eller gennemgå en eksisterende rutes form og fejl-responses. Reglerne er hardkodede og meningsbaserede, så fork SKILL.md og indsæt dine egne standarder, før du bruger den på et rigtigt projekt.
Testrapport
Installeret i en throwaway HOME=$(mktemp -d) og bekræftet, at SKILL.md landede på ~/.claude/skills/api-conventions/SKILL.md; frontmatter parset med yaml.safe_load (name, 273-tegns description, allowed-tools Read/Grep/Glob), body er 1231 tegn, der refererer til nul eksterne filer, og en grep efter curl|base64|eval|http://|/Users/ fandt intet. Samme opgave to gange — "design endpoints for listing a customer's coupons and redeeming one" — baseline.md vs skill.md i scratchpad: baseline returnerede et bart {"coupons":[...],"page","per_page","total"}-objekt, POST /api/coupons/{code}/redeem returnerede 200, og 409/410 for allerede-indløst/udløbet; skill-versionen returnerede {"data":[...],"error":null,"meta":{page,limit,total}} på hver response, flyttede handlingen til POST /api/v1/coupons/{code}/redemptions, der returnerede 201, kollapsede 409 og 410 til 422, tilføjede en 403 ownership-case og gjorde auth eksplicit som Bearer + en @public-annotation på det ene åbne endpoint. Trigger-fraser, jeg bedømte som load: "add a REST endpoint for listing a user's invoices — what should the URL and response body look like?", "review this Express route file and tell me if the error responses are right", "we're designing a new public orders API — what status code for a validation failure?"; bedømte som no-load: "write a Python client that calls the Stripe API and retries on 429" (forbrugende, ikke designende) og "the /users endpoint returns 500, help me find the null deref" (runtime debugging, ikke format) — 5/5 korrekt. Real caveat: det er en kursusdemo, så konventionerne er hardkodede til én forfatters husstil, og halvdelen af body-prosaen er kinesisk.
Testet: 2026-07-21 · Claude Code 2.x (agent harness)
Installation
git clone --depth 1 https://github.com/huangjia2019/claude-code-engineering.git /tmp/api-conventions-src
mkdir -p ~/.claude/skills
cp -R /tmp/api-conventions-src/04-Skills/projects/01-reference-skill/.claude/skills/api-conventions ~/.claude/skills/api-conventions
# Single self-contained SKILL.md (~1.7KB), no scripts, no deps, no API keys.
# Source repo is a Chinese course companion ("Claude Code 工程化实战") with 8+ demo skills;
# this slug is the 01-reference-skill example. Parts of the SKILL.md body (response-format
# and status-code notes) are written in Chinese; the rules themselves are language-neutral.
# IMPORTANT: the description says "conventions for this project" but the rules are the course
# author's, not yours. Edit ~/.claude/skills/api-conventions/SKILL.md to match your real
# standards, or it will push /api/v1, data/error/meta envelopes and 422 onto every codebase.
# frontmatter sets allowed-tools: Read, Grep, Glob (read-only). Kommandoer og eksempelprompter
/api-conventionsInterne REST-regler Claude anvender ved design af endpoints: URL-form, data/error/meta, 422
Skills udløses af almindelige forespørgsler — ingen kommandoer at huske. Efter installationen aktiverer prompter som disse skillen (på engelsk):
Design a new endpoint following our API conventionsReview this API for consistent error handlingCheck this response format against our standards