AGENT SKILL

api-contracts

暂无简介

适用职业开发工程师
使用场景后端与接口
License 许可
MIT
最近更新
2026-05-26
Stars
★ 0
Forks
0

02 资源文件 1

03 SKILL.md 正文

API Contracts

Follow ../_shared/skill-contract.md.

Purpose

Define stable request and response shapes for backend resources.

Use when

  • a new endpoint or resource is being planned

Do not use when

  • the task is runtime wiring only
  • the task is database tuning only

Inputs required

  • resource name
  • operation list
  • validation needs

Outputs expected

  • request and response contract
  • error contract
  • field list

Workflow

  1. Define the resource.
  2. Define operations and fields.
  3. Define error shapes.
  4. Define examples.
  5. Verify that the contract matches the task.

Validation checklist

  • [ ] Contract is explicit
  • [ ] Errors are defined
  • [ ] Field names are stable

References

  • ../../prompts/generate_api_contract.md
  • ../../examples/profile-update-contract.md

04 同仓库更多 Skills