這個技能是 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.