编程

Api Test Plan

试用

Plan tests for an API endpoint or service — functional, negative, and contract. Use when asked to test an API, write API test cases, plan REST/GraphQL endpoi...

它能做什么

Plan tests for an API endpoint or service — functional, negative, and contract. Use when asked to test an API, write API test cases, plan REST/GraphQL endpoint testing, or validate an API contract. Produces an API test plan — per-endpoint cases (status codes, schema, auth, validation, errors), boundary/negative cases, contract checks, and non-functional notes — so the API is verified beyond the happy 200.

技能文档

API Test Plan Skill

APIs fail in specific, testable ways: wrong status codes, schema drift, missing auth checks, sloppy validation, unhelpful errors. This skill plans the tests that catch them — per endpoint, across the response codes and the error paths, with contract checks so the API keeps its promises to clients. It tests the whole behaviour, not just the happy 200.

Working from a brief

Given an endpoint or an API description, produce the test plan anyway — infer the likely parameters, responses, auth model, and error cases, labelling assumptions. Always include auth, validation, and negative cases. Never hand back a question instead of a plan.

Required Inputs

Ask for these only if they aren't already provided (else infer and label):

  • The API — REST/GraphQL, the endpoints/operations, and what they do.
  • Contract — request/response schemas, parameters, status codes (or an OpenAPI/spec if available).
  • Auth & rules — the auth model (token/scopes/roles), rate limits, and validation rules.
  • Dependencies & data — downstream services, and the data/state needed to test.

Output Format

API Test Plan: [API / endpoint]

Per endpoint, a set of cases grouped by type:

IDEndpointCaseTypeRequestExpected statusExpected body / assertion
API-01POST /ordersvalid createFunctionalvalid payload201body matches schema, id returned
API-02POST /ordersmissing fieldValidationpartial payload400error names the field
API-03POST /ordersno tokenAuthvalid payload, no auth401not created
API-04POST /orderswrong roleAuthzvalid payload, wrong scope403not created
API-05GET /orders/{id}not foundNegativeunknown id404error body

Cover deliberately: happy path (correct status + schema), validation (missing/invalid/extra fields, types, boundaries), auth/authz (no token, expired, wrong scope/role), negative (not found, conflict, bad method), idempotency/concurrency where relevant, and errors (correct codes + helpful, consistent error bodies).

Contract checks — responses conform to the schema; required fields, types, and status codes match the spec; backward compatibility for existing clients.

Non-functional notes — rate limiting, pagination, large payloads, latency expectations, and security basics (no sensitive data leakage, proper status for unauthorised).

Setup — test data, environment, and any mocks/stubs for dependencies.

Quality Checks

  • Each endpoint is tested beyond 200 — error codes (4xx/5xx) and their bodies are asserted
  • Auth and authorization cases are included (no token, expired, wrong scope/role)
  • Validation/boundary/negative cases cover missing, invalid, and extra inputs
  • Responses are checked against the schema/contract, incl. backward compatibility
  • Status codes match the spec and are used correctly (e.g. 401 vs. 403, 400 vs. 422)
  • Non-functional aspects (rate limits, pagination, data leakage) are noted

Anti-Patterns

  • Do not test only the happy 200 — most API bugs are in validation, auth, and error paths
  • Do not ignore the response schema — a 200 with the wrong body still breaks clients
  • Do not skip authz (role/scope) testing — "logged in" isn't "allowed"
  • Do not assert only status codes — check the body/contract too
  • Do not overlook error-body quality and correct status semantics (401 vs 403, 400 vs 404)

Based On

API testing practice — contract/schema validation, status-code correctness, auth/authz coverage, and negative/boundary testing beyond the happy path.

相关技能

Generate complete automated API test cases from interface documentation such as OpenAPI, Swagger exports, Postman collections, Markdown API docs, or endpoint...

16 次安装

Write clear, developer-facing API documentation. Use when asked to document an API endpoint, write API reference docs, create a developer guide, or turn a ra...

Build reusable HTTP API test artifacts from user-provided endpoints, authentication, request data, expected results, and validation rules. Use this skill whe...

6 次安装

根据风险信号决定先规划还是直接执行,并按风险等级匹配规划深度,包含步骤、估算与回滚。

96 次安装2 星标

Review an API's contract as a promise to consumers — detects breaking changes by diffing the before/after surface (removed/renamed fields, type changes, tightened requiredness, status-code changes), and judges design by the repo's OWN precedent (error envelope, naming, pagination, auth placement) with every consistency finding citing the in-repo convention being violated. Covers versioning, idempotency on retryable writes, pagination on collections, and status-code semantics. Use this skill whenever the user says "review this API", "review the endpoint", "API design review", "is this a breaking change", "check backward compatibility", "review the contract", "review this OpenAPI/swagger spec", or "/api-contract-review" — even if they don't name the skill. Distinct from code-review (implementation quality); this reviews the SURFACE consumers depend on.

1 次安装

ProcessPlan (processplan.com). Use this skill for ANY ProcessPlan request — reading, creating, and updating data. Whenever a task involves ProcessPlan, use this skill instead of calling the API directly.

1 次安装