Results for “api-contract”

Configure this skill should be used when the user asks about "API contract", "api-contract.md", "shared interface", "TypeScript interfaces", "request response schemas", "endpoint design", or needs guidance on designing contracts that coordinate backend and frontend agents. Use when building or modifying API endpoints. Trigger with phrases like 'create API', 'design endpoint', or 'API scaffold'.

The English summary is being prepared. Showing the original description.

Design and review API contract tests, which check agreed request and response behavior. Examine schemas, server output, and client parsing to identify compatibility problems, reproduce failures locally, and report gaps in test coverage.

• Checking client impact before changing an API response
• Investigating client and server disagreements at runtime
• Reproducing compatibility failures with local test data

统一接口协议、请求响应、错误码、兼容性与上下游协作约束。 当架构师、前后端开发或 QA 需要锁定 API 合同时使用。

The English summary is being prepared. Showing the original description.

Use when auditing CloudBase cloud API wrappers, MCP tools, generated action metadata, or related docs for outdated or incorrect action names, parameters, casing, request shapes, or missing contract tests, especially during periodic quality review or before preparing corrective PRs.

The English summary is being prepared. Showing the original description.

前后端接口契约安全规范，适用于接口新增或调整、联调、列表分页异常与临时兼容治理；用于避免响应结构漂移被前端兼容长期掩盖。

The English summary is being prepared. Showing the original description.

Review REST API contracts for HTTP semantics, versioning, backward compatibility, and response consistency. Use when user asks "review API", "check endpoints", "REST review", or before releasing API changes.

The English summary is being prepared. Showing the original description.

Verifies API contracts between services using consumer-driven contracts, schema validation, and tools like Pact. Use when testing microservices communication, preventing breaking changes, or validating OpenAPI specifications.

The English summary is being prepared. Showing the original description.

Validate API changes against an expected contract. Use when a mid-level developer needs to detect breaking changes.

The English summary is being prepared. Showing the original description.

Use when a task adds or changes an HTTP endpoint, its request/response shape, status codes, auth or error format - the request matrix, curl templates and what counts as a contract break

The English summary is being prepared. Showing the original description.

Use when you add or change any HTTP endpoint's request or response shape (Go or Java) — implement the task's contract exactly, evolve additively, keep the OpenAPI document in sync, and detect breaking changes before hand-off

The English summary is being prepared. Showing the original description.

API 契约测试时使用。适用于消费者驱动契约测试（Pact）/ OpenAPI 验证（Dredd / Schemathesis）。融合 Pact + Schemathesis + 契约优先。

The English summary is being prepared. Showing the original description.

Produce or review API contract documentation for Salesforce integrations: versioning policy artifacts, request/response schema specs, error code catalogs, rate limit documentation, OpenAPI generation for sObjects. Trigger keywords: Salesforce API versioning policy, API end-of-life policy, document API endpoints, REST API rate limits, OpenAPI sObjects, API contract record, error contract, errorCode catalog, 410 GONE retired API version, HTTP 300 external ID upsert, idempotency key, deprecation notice, composite subrequest limit. NOT for building the endpoint or writing the Apex REST service — use apex/apex-rest-services. NOT for upgrading the API version on your own Apex, LWC or sfdx-project.json — use devops/api-version-management.

The English summary is being prepared. Showing the original description.

Verify ASP.NET Web services build the right IDownstreamApi route and payload without standing up HTTP

The English summary is being prepared. Showing the original description.

Checks layer leakage in method signatures, missing DTOs, entity leakage to API, inconsistent error contracts. Returns findings with penalty-based scoring.

The English summary is being prepared. Showing the original description.

Design and review durable REST, GraphQL, RPC, or event-facing API contracts. Use for public or shared API contracts, endpoint/schema consistency, compatibility, pagination, error semantics, and API documentation. Discovers existing consumers and conventions before recommending a style.

The English summary is being prepared. Showing the original description.

Design and review API contract tests across providers and consumers. Use for schema changes, compatibility regressions and client integration failures.

The English summary is being prepared. Showing the original description.

Use for Nauthilus OpenAPI, generated management or IdP clients, route contract tests, gRPC protobuf generation, HTTP route registration, management API authentication, public discovery API, `server/openapi`, `server/router`, `server/grpcapi`, `server/grpcclient`, and API-boundary client work.

The English summary is being prepared. Showing the original description.

Use when adding or changing REST endpoints or the OpenAPI contract — deriving endpoints from the Lean commands and views, writing documents/codebase/openapi.yaml first, then regenerating the backend controller interfaces and the frontend client.

The English summary is being prepared. Showing the original description.

Run the API contract workflow for public interface changes, compatibility constraints, contract tests, documentation, and review.

The English summary is being prepared. Showing the original description.

Run the API contract workflow for request/response shape changes, compatibility constraints, contract tests, documentation, and review.

The English summary is being prepared. Showing the original description.

Unifies API response patterns across endpoints including pagination format, error structure, status codes, response envelopes, and versioning strategy. Provides contract documentation, shared TypeScript types, middleware utilities, and migration plan. Use when standardizing "API contracts", "response formats", "API conventions", or "API consistency".

The English summary is being prepared. Showing the original description.