graph-api-design

Audit API governance and design for OpenAPI/Swagger compliance.

Updated Apr 26, 2026

Search Tags:#OpenAPI #REST API #Swagger #API governance #contract validation #API audit

Ready to run

npx skills add https://github.com/luissimon96/orchestration-devops-agents --skill graph-api-design

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: graph-api-design
Source: https://github.com/luissimon96/orchestration-devops-agents/tree/main/.agents/skills/graph-api-design
Command: npx skills add https://github.com/luissimon96/orchestration-devops-agents --skill graph-api-design

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires openapi-generator, swagger-parser, zod, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill provides a comprehensive API governance and design audit using OpenAPI/Swagger, REST maturity model, and contract validation, ensuring consistency and compliance across API surfaces.

Core Features & Use Cases

API Governance: Generates OpenAPI/Swagger specs for API documentation.
REST Maturity Model: Validates and enhances RESTful API design.
Contract Validation: Ensures endpoints have proper Zod schema validation.
Breaking Change Detection: Flags and documents breaking changes for migration paths.
Versioning & Deprecation: Tracks deprecated items and migration paths.
Documentation Check: Verifies API routes and MCP tools are well-documented.
API Report: Generates an audit report with compliance scores and recommendations.

Quick Start

Run the graph-api-design skill to audit the current API surface.

Frequently Asked Questions about graph-api-design

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

FAQPage Schema

How do I audit my OpenAPI spec for REST maturity and contract validation?▼

You can audit OpenAPI specs for REST maturity and contract validation by running an automated governance check that evaluates RESTful naming, verifies Zod schema compliance, and generates a report with compliance scores and recommendations.

What is the best way to detect breaking changes in a Swagger API specification?▼

Detecting breaking changes in a Swagger API specification involves comparing version histories using Git to flag modifications, document migration paths, and track deprecated items to ensure backward compatibility.

How does Zod schema validation work for API contract compliance?▼

Zod schema validation for API contract compliance works by checking that endpoints have proper schema definitions, ensuring data consistency and enforcing strict contract validation across API surfaces.

Can I use swagger-parser to verify if my API routes are well-documented?▼

Yes, you can use swagger-parser to verify if API routes are well-documented by executing a documentation check that validates OpenAPI/Swagger compliance and ensures comprehensive endpoint descriptions.

When do I need to track API versioning and deprecation paths?▼

You need to track API versioning and deprecation paths when updating endpoints to flag breaking changes, document migration paths for deprecated items, and maintain consistency across API surfaces.

Does API governance check RESTful naming conventions and OpenAPI compliance?▼

Yes, API governance checks RESTful naming conventions and OpenAPI compliance by auditing the API design, validating against the REST maturity model, and generating an audit report with compliance scores.