Api Engineer

作者 postmanlabs67cff8f385d8無授權條款收錄於 2026年10月8日更新於 2026年10月8日

Default entry point for API engineering work — designing, implementing, mocking, testing, monitoring, documenting, or deploying an API.

AI 產生的概覽

指導 API 工程工作,涵蓋契約設計、實作、模擬、測試、文件與部署。

功能
這個技能是 API 工程任務的預設進入點。它提出以 API 契約為先的原則,建議用 OpenAPI 規格或 Postman 集合記錄契約,並依據該契約驗證變更。它指向模擬、測試、文件、探索與以 CI 為基礎的部署等相關活動,並建議提出後續步驟,而不是直接進入實作。
適用情境
適用於啟動或協調 API 工程工作時,例如設計、實作、模擬、測試、監控、撰寫文件或部署 API。適合希望採用契約優先流程並分階段推進的情境。
執行需求
不附帶指令碼,僅為指令型技能。它提及 Postman 集合、OpenAPI 規格、Postman 工作區推送與 CI 整合等工具與實務,但本身不需要憑證或網路存取。

API Engineer

Foundations

  1. Contract comes first. Establish and document the contract before starting implementation.
  2. A Postman collection and/or an OpenAPI spec is a very good option to capture the API contract - see api-documentation.
  3. 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.
  4. Always propose next steps. Example: contract -> implementation -> testing -> pushing to cloud -> sharing with others.
  5. 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.
  6. 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.
  7. For high-quality API search results, use api-discovery.
  8. No is an acceptable answer. Asked whether to do something, invited to add scope, or shown an approach, reply with your real judgment.

Dos

  1. Prove it works - validate the task against the contract. See api-testing.
  2. 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.
  3. Fight for good API design. See api-documentation.

來源與署名

來源:postmanlabs/postman-plugin位於skills/api-engineer提交67cff8f

授權條款: 無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架

更多來自 postmanlabs/postman-plugin 的技能

Performance Testing

postmanlabs

以虛擬使用者、負載設定檔和通過/失敗門檻執行 Postman 集合負載測試。

Software Development2026年10月8日

Flows

postmanlabs

透過命令列操作 Postman Flows:列出、執行、觸發、部署、更新並偵錯流程及其執行紀錄。

DevOps & Cloud2026年10月8日

Ci Integration

postmanlabs

將 Postman CLI 檢查以獨立的通過/失敗關卡加入 CI 流程。

DevOps & Cloud2026年10月8日

Api Testing

postmanlabs

Runs tests against an API from the command line — a single ad-hoc request, a full collection of pm.test assertions, or matching real captured app traffic against a collection contract. Use when the user asks to "test this endpoint," "run this collection," "check the API still works," or "verify my app's requests match the contract." Covers `postman request`, `postman collection run`, and `postman application test`. Depends on bootstrap when the target is a cloud collection or workspace-bound environment; a bare URL or local collection needs nothing from bootstrap.

待分類2026年10月8日

Api Monitoring

postmanlabs

Creates, schedules, and manages Postman Monitors — recurring checks against a live API — triggers ad hoc runs, inspects job/run history to diagnose failures, and hosts self-hosted execution runners for monitors on a private network. Use when the user asks to "set up a monitor," "run this monitor now," "check monitor results," "pause/resume a monitor," or "set up a runner for our internal APIs." Covers `postman monitor` (create, update, delete, list, get, pause, resume, run, jobs, runs) and `postman runner` (start, list, regions).

待分類2026年10月8日

Api Mocking

postmanlabs

在本機或雲端建立並執行模擬 API 後端,支援情境與狀態碼覆寫以便測試。

Software Development2026年10月8日