Skip to main content

test-an-api-integration

Test an API integration across contract, authentication, state, retries, errors, limits, observability, and cleanup. Use when verifying a new or changed consumer-provider connection before release.

来源信息

仓库
protosphinx/sphinxstack
最近来源活动
2026年7月29日 13:55
检测到的 SKILL.md 语言
英语
星标
3
Forks
0

安装方式

默认使用会先检查来源的 Prompt;你也可以切换为直接命令,或下载本地副本。

检查来源文件

决定是否安装前,请先阅读 SKILL.md,以及 SkillsMP 当前展示的配套文件。

文件资源管理器
2 个文件

正在显示 SKILL.md

SKILL.md
来源说明 · 只读预览
name
test-an-api-integration
category
code
description
Test an API integration across contract, authentication, state, retries, errors, limits, observability, and cleanup. Use when verifying a new or changed consumer-provider connection before release.
# test-an-api-integration Exercise the integration as a stateful conversation, not a single happy request. Prove how it behaves when either side is slow, unavailable, duplicated, changed, or only partly successful. ## Inputs - Gather the versioned contract, consumer behavior, provider environment, credentials, quotas, webhooks, and support path. - Identify side effects, idempotency, pagination, async jobs, eventual consistency, retries, and data retention. - Prepare a sandbox or approved isolated account with synthetic data. ## Procedure 1. Record the supported contract version, permissions, endpoints, events, and expected state transitions. 2. Verify authentication, authorization, expiration, rotation, and least-privilege failure behavior. 3. Test representative valid requests and reconcile consumer and provider state. 4. Exercise invalid input, missing permission, conflict, not found, and version mismatch. 5. Simulate timeout, rate limit, provider error, dropped response, delayed webhook, and duplicate delivery. 6. Verify idempotency, retry backoff, pagination, ordering, deduplication, and reconciliation. 7. Check logs, metrics, correlation identifiers, alerts, and privacy-safe diagnostic context. 8. Test schema additions and removals against the consumer's parsing behavior. 9. Clean up test resources and confirm no credentials or synthetic records leak. 10. Save a contract test report with failures, owners, and release decision. ## Boundaries Never test destructive or billable operations against production without explicit approval. Do not store real credentials or customer payloads in fixtures and logs. Respect provider rate limits and terms. ## Done - Contract, permissions, happy path, errors, retries, limits, and asynchronous behavior are tested - Consumer and provider state reconcile after success, duplicate, timeout, and partial failure - Diagnostic signals identify failures without exposing secrets or private payloads - Cleanup is verified and the report records evidence, exceptions, owners, and release decision
在 GitHub 查看