Bỏ qua tới nội dung
TakoAPI
Quay lại kỹ năng

jarvis-api-contract-guard-01

bởi xammarie

Browser & Automation
387Lượt tải do clawskills.sh công bố
0Lượt xem
0 lượt thíchĐăng nhập để thích kỹ năng này
—Chưa có đánh giá
Đánh giá của bạn

Tóm tắt

Design and verify API contracts for backward compatibility.

Mô tả

Kỹ năng này làm gì

A structured workflow for designing and verifying API contracts with a focus on backward compatibility. Takes code, docs, and constraints as inputs, runs through defined checkpoints with quality gates, and returns prioritized findings with a concrete action plan.

The checkpoint-and-quality-gate structure forces evidence-backed claims and explicit tradeoffs, reducing the chance that risky changes ship without a documented fallback.

Khi nào nên dùng

  • Checking an API change for breaking changes before merging
  • Turning informal notes into a ranked action plan with acceptance criteria
  • Reviewing a public endpoint refactor with rollback options documented
  • Planning a deprecation timeline with owner and ETA per step
  • Auditing a third-party integration contract before a release

Quy trình ví dụ

ĐẦU VÀO

User asks: Here's my updated /payments endpoint diff. Check it for backward compatibility issues and give me an action plan.

AGENT
  1. 1

    Defines success criteria: no breaking changes to existing consumers

  2. 2

    Identifies the smallest-valid execution path by listing all changed request/response fields

  3. 3

    Executes checkpoints: compares old and new schemas, flags removed fields and changed types

  4. 4

    Applies quality gates: confirms findings are evidence-backed and assumptions are explicit

  5. 5

    Returns ranked findings, a today/this-week action plan, risks with mitigations, and a checklist of exact fixes

ĐẦU RA

A prioritized list of compatibility issues, each with impact rating, a concrete fix or migration step, and a fallback if the primary plan fails

Cài đặt

clawhub install xammarie/jarvis-api-contract-guard-01

Chạy lệnh CLI, hoặc dán prompt vào Claude Code, Cursor, Codex hay coding agent bạn đang dùng.

Liên kết