api-design SKILL.md skillA
api-design from umararshad4/honey-stack is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add umararshad4/honey-stack/api-design@git:20261017.c52b424Pins git:20261017.c52b424 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- umararshad4/honey-stack
- Path
skills/api-design/SKILL.md- Versions recorded
- 2
- Latest version
- git:20261017.c52b424, committed Oct 17, 2026
- First version recorded
- Oct 17, 2026
- Size
- 4,737 bytes
- Repository stars
- 4
- License
- MIT
Design or evolve an API: pick REST/GraphQL/gRPC/tRPC, model resources and status codes, version without breaking, RFC 9457 errors, cursor pagination, idempotency, schema-first OpenAPI/proto/GraphQL contracts.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# api-design Design an API that's hard to misuse and safe to evolve. Choose the style, model it cleanly, and never break a published contract. ## Pick the style - **REST** — public/partner APIs, CRUD-ish resources, broad clients, cacheability. Add OpenAPI for the schema. - **GraphQL** — client-driven read graphs, mobile/BFF, many screens needing different fields. Cost: N+1, hard HTTP caching, per-field auth, depth-limit DoS. - **gRPC** — internal service-to-service, low latency, streaming, polyglot. Not browser-native (needs grpc-web/Connect). - **tRPC** — a single TypeScript monorepo wanting end-to-end types with no codegen. TS-only; not a cross-language public contract. Rule: public/unknown clients → REST+OpenAPI; internal mesh → gRPC; flexible field selection → GraphQL; one TS codebase → tRPC. ## REST done well …
Read the whole file at its exact version.
How to install
mdr add umararshad4/honey-stack/api-design@sha256:bea62cf04c53d94bThe line at the top of this page pins the label git:20261017.c52b424, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_xuw6fdycoqsizl5m)
1 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, all committed on Oct 17, 2026.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261017.c52b424 latest | 2026-10-17 | c52b424 | 4,737 B | A | view · diff |
| git:20261017.e40035b | 2026-10-17 | e40035b | 4,712 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (4737 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
umararshad4/honey-stack · 4 stars · license MIT · pushed 2026-11-01 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_xuw6fdycoqsizl5m GET https://markdownregistry.com/api/v1/resolve?ref=umararshad4/honey-stack/api-design GET https://markdownregistry.com/api/v1/blob/bea62cf04c53d94b71c4f97947161709ce06ac5d58a52aba5b0742f8f79f84a8
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from umararshad4/honey-stack
Every file in umararshad4/honey-stack