skills.rest
wojons
wojonsCOMMUNITY
Explore all skills by this author →
Website𝕏@WojonsTechGitHub

spec-gap-analysis

Detect gaps between formal specifications and their implementations.

4|2|Updated Feb 26, 2026
Search Tags:#openapi#protobuf#architecture review#contract testing#code validation#specification analysis#api compliance
One-click install
npx skills add https://github.com/wojons/skills --skill spec-gap-analysis
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: spec-gap-analysis
Source: https://github.com/wojons/skills/tree/main/skills/spec-gap-analysis
Command: npx skills add https://github.com/wojons/skills --skill spec-gap-analysis

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill bridges the gap between your formal specifications (like API definitions or architecture diagrams) and your actual code, ensuring your implementation truly matches your design.

Core Features & Use Cases

  • API Contract Validation: Verifies if your REST, GraphQL, or gRPC implementations adhere to their OpenAPI, GraphQL Schema, or Protobuf definitions.
  • Architecture Compliance: Checks if your codebase aligns with architectural specifications (e.g., C4 models, UML).
  • Use Case: Ensure your deployed API endpoints exactly match the OpenAPI specification, catching any deviations before they cause integration issues.

Quick Start

Analyze the compliance of the OpenAPI specification file 'openapi.yaml' against the implementation code in the 'src/' directory.

Frequently Asked Questions about spec-gap-analysis

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

FAQPage Schema
How do I validate my OpenAPI specification against source code?▼

To validate OpenAPI specifications against source code, analyze the compliance of your 'openapi.yaml' file against the implementation code in your 'src/' directory. This detects gaps in endpoints, parameters, and schemas to ensure contract adherence.

What is API contract testing and how does it detect specification gaps?▼

API contract testing detects specification gaps by comparing formal definitions like OpenAPI, Protobuf, or GraphQL against actual implementations. It identifies discrepancies in endpoints, parameters, schemas, and behavior to verify that code matches the design.

Can I check if my gRPC implementation matches its Protobuf definitions?▼

Yes, you can check if gRPC implementations match Protobuf definitions by analyzing compliance between the structured specification and the implementation code. This verifies that deployed endpoints align with the defined schemas and behavior.

Does architecture compliance checking support C4 models and UML diagrams?▼

Architecture compliance checking supports C4 models and UML diagrams by analyzing if your codebase aligns with these architectural specifications. It detects behavioral and structural gaps between the formal architecture design and the actual implementation.

What is the best way to find discrepancies between API definitions and implementation?▼

The best way to find API discrepancies is to run a specification gap analysis that compares structured formats like OpenAPI, GraphQL, or Protobuf against your codebase. This catches deviations in parameters and schemas before they cause integration issues.

Related Skills

Explore More Software Engineering Skills→
ChazzCoinChazzCoin

schema-check

Detects schema drift between canonical sources and local mirrors.

Community
Advanced
carl10086carl10086
7

api-and-interface-design

Guide REST and GraphQL API design with contract-first, backward-compatible interfaces.

Community
Intermediate
eleva-labseleva-labs

api-validate

Validate API implementations against OpenAPI specifications and contracts.

Official
Intermediate
vladkeslervladkesler
39

response-validation

Validate API responses against stored schemas to detect drift and structural issues.

Community
Intermediate