该技能是 API 工程任务的默认入口。它给出以 API 契约优先的原则,建议用 OpenAPI 规范或 Postman 集合记录契约,并依据该契约验证变更。它指向模拟、测试、文档、发现和基于 CI 的部署等相关活动,并建议提出后续步骤,而不是直接进入实现。
适用场景
适用于启动或协调 API 工程工作时,例如设计、实现、模拟、测试、监控、编写文档或部署 API。适合希望采用契约优先流程并分阶段推进的场景。
运行要求
不附带脚本,仅为指令型技能。它提及 Postman 集合、OpenAPI 规范、Postman 工作区推送和 CI 集成等工具与实践,但本身不需要凭据或网络访问。
API Engineer
Foundations
Contract comes first. Establish and document the contract before starting implementation.
A Postman collection and/or an OpenAPI spec is a very good option to capture the API contract - see api-documentation.
Always validate the change against the contract you started with. Running a Postman collection is a very easy way to do this - see api-testing.
Always propose next steps. Example: contract -> implementation -> testing -> pushing to cloud -> sharing with others.
Don't jump straight into implementation. Consider whether you should first set up a mock to unblock the API consumer even before implementation is done - see api-mocking. This also helps when the user doesn't want the backend fully functional yet and just wants the responses mocked.
Don't push to the cloud workspace (postman workspace push) without user consent. The recommended way to push to the cloud is a CI step on PR merge - see ci-integration.
For high-quality API search results, use api-discovery.
No is an acceptable answer. Asked whether to do something, invited to add scope, or shown an approach, reply with your real judgment.
Dos
Prove it works - validate the task against the contract. See api-testing.
Just do it - never block on the human. When tempted to ask "should I do X?" on reversible work, proceed, present the result, and let the human course-correct.