principle-api-design SKILL.md skillA
principle-api-design from lugassawan/swe-workbench is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add lugassawan/swe-workbench/principle-api-design@git:20260828.71a6399Pins git:20260828.71a6399 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- lugassawan/swe-workbench
- Path
skills/principle-api-design/SKILL.md- Versions recorded
- 3
- Latest version
- git:20260828.71a6399, committed Aug 28, 2026
- First version recorded
- Apr 29, 2026
- Size
- 5,552 bytes
- Repository stars
- 3
- License
- MIT
API design principles — contract-first thinking, semantic versioning, idempotency keys, pagination (offset vs cursor), REST vs RPC vs event-driven trade-offs, resource modeling, deprecation strategy. Auto-load when designing an API, adding api versioning, adding pagination, shaping error responses, or evolving a public contract.
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
<!-- preload-canary: SWB-PRELOAD-PRINCIPLE-API-DESIGN --> # API Design An API is a contract. Breaking it breaks callers. Design for evolvability from day one. ## Contract-First Design the interface before the implementation. Write the schema or proto before any code. - Contracts force clarity on resource modeling, field names, and error cases early. - If the design is painful to describe, the implementation will be painful to use. - API review at design time is cheap; API review after clients exist is very expensive. ## Versioning Every breaking change requires a new version. Communicate it, window it, enforce the schedule. - **Breaking:** removing a field, changing a field type, changing semantics of a status code, renaming a resource. - **Additive (non-breaking):** new optional fields, new endpoints, new enum values in response. - **URL-path versioning** (`/v1/orders`) — visible, cacheable, easy to route; good for major versions. - **Header versioning** (`API-Version: 2024-01-01`) — cleaner URLs; common for date-based schemes. - Set a deprecation window (minimum 6 months for external APIs) and enforce it; sunset headers signal the date. ## Idempotency …
Read the whole file at its exact version.
How to install
mdr add lugassawan/swe-workbench/principle-api-design@sha256:3e5e8f175d4d634aThe line at the top of this page pins the label git:20260828.71a6399, 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_r2wdgxzn3vmpw4kh)
1 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 3 versions of this file, between Apr 29, 2026 and Aug 28, 2026, about one every 60 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260828.71a6399 latest | 2026-08-28 | 71a6399 | 5,552 B | A | view · diff |
| git:20260725.074b496 | 2026-07-25 | 074b496 | 5,719 B | A | view · diff |
| git:20260429.cfd17ac | 2026-04-29 | cfd17ac | 5,661 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 (5552 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
lugassawan/swe-workbench · 3 stars · license MIT · pushed 2026-11-07 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_r2wdgxzn3vmpw4kh GET https://markdownregistry.com/api/v1/resolve?ref=lugassawan/swe-workbench/principle-api-design GET https://markdownregistry.com/api/v1/blob/3e5e8f175d4d634a4da14ee31fcebe31806387740a4d3c948550860e8869d37f
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.