Skills
.Work. You
Rest

api-service-contracts

Official

Document API contracts and diagram the flow.

Software Engineering#documentation#openapi#endpoints#sequence-diagram#api-contracts#service-catalog
Authormicrosoft
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Document and reason about API surfaces by generating a comprehensive catalog of services, endpoints, and data contracts, including a Mermaid sequence diagram that shows core request flows.

Core Features & Use Cases

  • Generate a complete Service Catalog with service/module names, purposes, and boundaries.
  • Build an API Endpoints Inventory listing HTTP methods, paths, request bodies, and response types.
  • Produce a Management & Observability endpoints catalog and capture references to custom metrics.
  • Create a Service Communication Diagram (Mermaid) illustrating synchronous and asynchronous calls, as well as failure and retry scenarios.
  • Distinguish gateway-level DTOs from service-level domain models to support API governance.

Quick Start

Run the API service-contracts skill on your codebase to generate contract documents and a Mermaid sequence diagram for the current project.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: api-service-contracts
Download link: https://github.com/microsoft/github-copilot-modernization/archive/main.zip#api-service-contracts

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 510,000+ vetted skills library on demand.