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日