api-design SKILL.md skillA

api-design from affaan-m/ecc is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add affaan-m/ecc/api-design@git:20260607.ac0f11c

Pins git:20260607.ac0f11c in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
affaan-m/ecc
Path
docs/es/skills/api-design/SKILL.md
Versions recorded
1
Latest version
git:20260607.ac0f11c, committed Jun 7, 2026
Size
14,011 bytes
Repository stars
293,827
License
MIT

Patrones de diseño REST API incluyendo nomenclatura de recursos, códigos de estado, paginación, filtrado, respuestas de error, versionado y rate limiting para APIs de producción.

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

# Patrones de Diseño de API

Convenciones y buenas prácticas para diseñar APIs REST consistentes y amigables para desarrolladores.

## Cuándo Activar

- Diseñar nuevos endpoints de API
- Revisar contratos de API existentes
- Agregar paginación, filtrado u ordenamiento
- Implementar manejo de errores para APIs
- Planificar la estrategia de versionado de API
- Construir APIs públicas o para partners

## Diseño de Recursos

### Estructura de URL

```
# Los recursos son sustantivos, plural, minúsculas, kebab-case
GET    /api/v1/users
GET    /api/v1/users/:id
POST   /api/v1/users
PUT    /api/v1/users/:id
PATCH  /api/v1/users/:id
DELETE /api/v1/users/:id

# Sub-recursos para relaciones
GET    /api/v1/users/:id/orders
POST   /api/v1/users/:id/orders

# Acciones que no mapean a CRUD (usar verbos con moderación)
POST   /api/v1/orders/:id/cancel
POST   /api/v1/auth/login
POST   /api/v1/auth/refresh
```

### Reglas de Nomenclatura

```
# BIEN
/api/v1/team-members          # kebab-case para recursos de varias palabras
/api/v1/orders?status=active  # query params para filtrado
/api/v1/users/123/orders      # recursos anidados para pertenencia

# MAL
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add affaan-m/ecc/api-design@sha256:ca053f1d30f0eee5

The line at the top of this page pins the label git:20260607.ac0f11c, 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.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_c27nmnu5himsvys7.svg)](https://markdownregistry.com/a/art_c27nmnu5himsvys7)

4 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 1 version of this file, committed on Jun 7, 2026.

versioncommittedcommitsizeaudit
git:20260607.ac0f11c latest2026-06-07 ac0f11c 14,011 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (14011 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

GitHub

affaan-m/ecc · 293,827 stars · license MIT · pushed 2026-10-30 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_c27nmnu5himsvys7
GET https://markdownregistry.com/api/v1/resolve?ref=affaan-m/ecc/api-design
GET https://markdownregistry.com/api/v1/blob/ca053f1d30f0eee5755f6bf697df65c8dd4b3c79afdb8b36d279f77f8d0a8e34

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 affaan-m/ecc

agent-introspection-debugging SKILL.md skill
affaan-m/ecc · .agents/skills/agent-introspection-debugging/SKILL.md · Structured self-debugging workflow for AI agent failures using capture, diagnosis, contained recovery, and…
git:20260918.c752aac · audit A · 293,827 stars
agent-sort SKILL.md skill
affaan-m/ecc · .agents/skills/agent-sort/SKILL.md · Build an evidence-backed ECC install plan for a specific repo by sorting skills, commands, rules, hooks, and extras…
git:20260918.c752aac · audit A · 293,827 stars
api-design SKILL.md skill
affaan-m/ecc · .agents/skills/api-design/SKILL.md · REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning…
git:20260918.c752aac · audit A · 293,827 stars
article-writing SKILL.md skill
affaan-m/ecc · .agents/skills/article-writing/SKILL.md · Write articles, guides, blog posts, tutorials, newsletter issues, and other long-form content in a distinctive voice…
git:20260918.c752aac · audit A · 293,827 stars
backend-patterns SKILL.md skill
affaan-m/ecc · .agents/skills/backend-patterns/SKILL.md · Backend architecture patterns, API design, database optimization, and server-side best practices for Node.js, Express…
git:20260918.c752aac · audit A · 293,827 stars
benchmark-methodology SKILL.md skill
affaan-m/ecc · .agents/skills/benchmark-methodology/SKILL.md · Use after competitive-platform-analysis has produced a tiered competitor set. Scores each competitor across nine…
git:20260918.c752aac · audit A · 293,827 stars
brand-discovery SKILL.md skill
affaan-m/ecc · .agents/skills/brand-discovery/SKILL.md · Use when a brand needs to discover or articulate its identity through structured multi-session interviews. Covers…
git:20260918.c752aac · audit A · 293,827 stars
brand-voice SKILL.md skill
affaan-m/ecc · .agents/skills/brand-voice/SKILL.md · Build a source-derived writing style profile from real posts, essays, launch notes, docs, or site copy, then reuse that…
git:20260918.c752aac · audit A · 293,827 stars
bun-runtime SKILL.md skill
affaan-m/ecc · .agents/skills/bun-runtime/SKILL.md · Bun as runtime, package manager, bundler, and test runner. When to choose Bun vs Node, migration notes, and Vercel…
git:20260928.48decd0 · audit B · 293,827 stars
change-impact SKILL.md skill
affaan-m/ecc · .agents/skills/change-impact/SKILL.md · Perform evidence-backed impact analysis before changing code, data, interfaces, or governance documents, then compare…
git:20261002.4f08958 · audit A · 293,827 stars
coding-standards SKILL.md skill
affaan-m/ecc · .agents/skills/coding-standards/SKILL.md · Baseline cross-project coding conventions for naming, readability, immutability, and code-quality review. Use detailed…
git:20260918.c752aac · audit A · 293,827 stars
competitive-platform-analysis SKILL.md skill
affaan-m/ecc · .agents/skills/competitive-platform-analysis/SKILL.md · Use when scoping a competitive landscape — identifying, categorising, and score-filtering a competitor set before any…
git:20260918.c752aac · audit A · 293,827 stars

Every file in affaan-m/ecc

Other files named api-design

api-design SKILL.md skill
affaan-m/ecc · .agents/skills/api-design/SKILL.md · REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning…
git:20260918.c752aac · audit A · 293,827 stars
api-design SKILL.md skill
affaan-m/ecc · .kiro/skills/api-design/SKILL.md · REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning…
git:20260323.535120d · audit A · 293,827 stars
api-design SKILL.md skill
affaan-m/ecc · docs/ja-JP/skills/api-design/SKILL.md · リソース命名、ステータス コード、ページネーション、フィルタリング、エラー応答、バージョン管理、およびレート制限を含む REST API デザイン パターン。
git:20260517.ec9ace9 · audit A · 293,827 stars
api-design SKILL.md skill
cbrock84/headcount · plugins/technology/skills/api-design/SKILL.md · Designs interfaces that survive their consumers — resource modeling, errors, versioning, pagination, and compatibility…
git:20260916.e72e404 · audit A · 2,543 stars
api-design SKILL.md skill
hashgraph-online/awesome-codex-plugins · plugins/Colin4k1024/tsp/skills/api-design/SKILL.md · REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning…
git:20260512.6523792 · audit A · 1,501 stars
api-design SKILL.md skill
ericrisco/rsc-harness · skills/api-design/SKILL.md · Use when settling the contract of an API you expose, before implementation: resources/URLs, REST vs GraphQL…
git:20260729.3ecb845 · audit A · 429 stars
api-design SKILL.md skill
yonatangross/orchestkit · plugins/ork/skills/api-design/SKILL.md · API wire contracts for REST and GraphQL: resource shape, versioning and deprecation, RFC 9457 errors, OpenAPI. Use when…
v2.0.0 · audit A · 299 stars
api-design SKILL.md skill
yonatangross/orchestkit · src/skills/api-design/SKILL.md · API contract design for REST and GraphQL, covering resource shape, URL and header versioning with deprecation windows…
v2.0.0 · audit A · 299 stars

Browse by kind, by grade A, or by owner.