dev-api-design SKILL.md skillA
dev-api-design from joaoguirunas/team-os is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add joaoguirunas/team-os/dev-api-design@v1.1Pins v1.1 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- joaoguirunas/team-os
- Path
.claude/skills/dev-api-design/SKILL.md- Versions recorded
- 2
- Latest version
- v1.1, committed Sep 26, 2026
- First version recorded
- Apr 23, 2026
- Size
- 3,926 bytes
- Repository stars
- 5
- License
- MIT
Design de APIs para software complexo — REST, tRPC, contratos, versionamento e error responses padronizadas.
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 — Software Complexo
## REST — Nomenclatura
```
GET /users → listar
GET /users/:id → buscar por ID
POST /users → criar
PUT /users/:id → substituir completo
PATCH /users/:id → atualizar parcial
DELETE /users/:id → remover
# Ações não-CRUD (POST + verbo explícito)
POST /users/:id/deactivate
POST /auth/refresh
POST /payments/:id/refund
```
Regras: plural sempre (`/users`), nunca verbos em recursos, máx 2 níveis de aninhamento.
## Responses
### Sucesso
```json
{
"data": { "id": "usr_123", "email": "user@example.com" },
"meta": { "requestId": "req_abc" }
}
```
### Lista paginada
```json
{
"data": [...],
"pagination": { "page": 1, "perPage": 20, "total": 150, "hasNext": true }
}
```
### Erro — padrão obrigatório
```json
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request data",
"details": [{ "field": "email", "message": "Must be a valid email" }],
"requestId": "req_abc"
}
}
```
…Read the whole file at its exact version.
How to install
mdr add joaoguirunas/team-os/dev-api-design@sha256:9fc22c70f5777629The line at the top of this page pins the label v1.1, 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_6upjpi7bspdgpkzz)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between Apr 23, 2026 and Sep 26, 2026, about one every 156 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.1 latest | 2026-09-26 | 8a9bf22 | 3,926 B | A | view · diff |
| v1.1 | 2026-04-23 | b70017d | 3,924 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 (3926 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
joaoguirunas/team-os · 5 stars · license MIT · pushed 2026-10-14 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_6upjpi7bspdgpkzz GET https://markdownregistry.com/api/v1/resolve?ref=joaoguirunas/team-os/dev-api-design GET https://markdownregistry.com/api/v1/blob/9fc22c70f577762992793590ef0503b628e6d460a9507f2a31c64cdf2b050e6d
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 joaoguirunas/team-os
Every file in joaoguirunas/team-os