api-design
Use when: design a clear, consistent, and evolvable API contract before implementing it.
Datos de origen
- Repositorio
- kimtth/agent-skill-100-lines-or-less
- Última actividad en el origen
- 26 de junio de 2026 a las 02:15
- Idioma detectado de SKILL.md
- inglés
- Estrellas
- 2
- Forks
- 0
Opciones de instalación
De forma predeterminada está seleccionado el prompt que primero revisa el origen. Puedes cambiar a un comando directo o descargar una copia local.
Revisa los archivos de origen
Lee SKILL.md y los archivos complementarios que muestra SkillsMP antes de decidir si quieres instalarlo.
Mostrando SKILL.md
SKILL.md
Instrucciones de origen · Vista previa de solo lectura- name
- api-design
- description
- Use when: design a clear, consistent, and evolvable API contract before implementing it.
Goal: an API that is predictable, hard to misuse, and safe to evolve.
Use for:
- designing a new API surface or endpoint set
- reviewing naming, consistency, and error semantics
- planning backward-compatible changes
Workflow:
1. Model the resources and operations from the consumer's view.
2. Use consistent naming, casing, and pluralization.
3. Define clear request/response shapes and error formats.
4. Choose explicit status codes and meaningful error bodies.
5. Plan versioning and backward compatibility up front.
6. Document the contract and validate it against real usage.
Principles:
- make the common case simple and the right thing easy
- consistent conventions beat per-endpoint cleverness
- return structured, actionable errors
- design for additive, non-breaking evolution
Rules:
- never break a published contract silently; version it
- validate inputs and reject ambiguity explicitly
- keep responses predictable in shape and naming
- document before consumers depend on undocumented behavior
Ver en GitHub