api-design
Use when: design a clear, consistent, and evolvable API contract before implementing it.
Informations de source
- Dépôt
- kimtth/agent-skill-100-lines-or-less
- Dernière activité de la source
- 26 juin 2026 à 02:15
- Langue détectée de SKILL.md
- anglais
- Étoiles
- 2
- Forks
- 0
Options d'installation
Le prompt qui vérifie d'abord la source est sélectionné par défaut. Vous pouvez passer à une commande directe ou télécharger une copie locale.
Vérifiez les fichiers source
Lisez SKILL.md et les fichiers associés affichés par SkillsMP avant de décider de l'installer.
Affichage de SKILL.md
SKILL.md
Instructions source · Aperçu en lecture seule- 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
Voir sur GitHub