skills.rest
bianliuzhu
bianliuzhuCOMMUNITY
Explore all skills by this author →
GitHub

API 变更检测报告

Analyze API definition and TypeScript type changes to generate impact reports.

4|2|Updated Feb 13, 2023
Search Tags:#typescript#api#code generation#impact analysis#reporting#change detection
One-click install
npx skills add https://github.com/bianliuzhu/an-cli --skill api-bianliuzhu
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: API 变更检测报告
Source: https://github.com/bianliuzhu/an-cli/tree/main/postbuild-assets/skills/api-report
Command: npx skills add https://github.com/bianliuzhu/an-cli --skill api-bianliuzhu

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the detection of changes in API definitions and generated type files, helping to identify potential breaking changes and their impact on the codebase.

Core Features & Use Cases

  • API Change Detection: Compares current API files with historical versions to identify additions, deletions, and modifications.
  • Type Definition Analysis: Scans changes in TypeScript type definition files.
  • Impact Analysis: Scans the codebase to find references to changed APIs and types.
  • Report Generation: Produces a structured report detailing breaking changes, warnings, compatible changes, and affected files.
  • Use Case: After regenerating API client code from Swagger, this Skill can alert developers to any breaking API changes that might affect frontend components, allowing for proactive fixes.

Quick Start

Run the API report skill to analyze changes in the API directory and scan the source code for affected files.

Frequently Asked Questions about API 变更检测报告

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I detect breaking API changes in TypeScript type definitions?▼

To detect breaking API changes in TypeScript type definitions, analyze API definition files and corresponding type changes. This process identifies breaking, warning, and compatible modifications by comparing current files against git history or workspace diffs.

How do I analyze the impact of API changes on my codebase?▼

To analyze the impact of API changes on your codebase, scan specified directories for code references to the changed APIs and TypeScript types. This generates a structured impact report detailing the affected files and modification severity.

Can I compare API definition files against git history to find modifications?▼

Yes, you can compare API definition files against git history to find modifications. The analysis supports comparison against git history and workspace diffs to identify additions, deletions, and modifications in your types.

Does this API impact analysis work with code generated from Swagger?▼

Yes, this API impact analysis works with code generated from Swagger. After regenerating API client code from Swagger, it alerts developers to breaking changes that might affect frontend components, allowing for proactive fixes.

What is included in a structured API change impact report?▼

A structured API change impact report includes breaking changes, warnings, compatible changes, and a list of affected files. It details additions, deletions, and modifications found by scanning the codebase for references to the updated definitions.

Related Skills

Explore More Software Engineering Skills→
SSiertsemaSSiertsema

baseline-management

Capture, compare, and release immutable baselines of artifacts with auditable history.

Community
Advanced
nahisahonahisaho
12

change-impact-analyzer

Analyze proposed changes to detect breaking changes and generate impact reports.

Community
Advanced
ananddtyagiananddtyagi
687

API Contract Sync Manager

Validate API contracts against backend implementations and generate TypeScript clients.

Community
Advanced
XSpoonAiXSpoonAi
17

api-contract-diff

Compare OpenAPI and GraphQL schemas to produce categorized JSON diffs.

Official
Advanced