skills.rest
musher-dev
musher-devOFFICIAL
Explore all skills by this author →
WebsiteGitHub

shaping-reviewing-api-contracts

Validate API contracts in architecture sketches for coverage, naming, errors, pagination, versioning, and authorization.

Updated Mar 6, 2026
Search Tags:#api design#api review#contract validation#endpoint coverage#architecture sketch#rest conventions
One-click install
npx skills add https://github.com/musher-dev/bundles --skill shaping-reviewing-api-contracts
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: shaping-reviewing-api-contracts
Source: https://github.com/musher-dev/bundles/tree/main/project-shaping-orchestration/skills/reviewing-api-contracts
Command: npx skills add https://github.com/musher-dev/bundles --skill shaping-reviewing-api-contracts

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures that proposed API endpoints in an architecture sketch are complete, consistent, and well-designed before implementation begins, preventing costly mistakes.

Core Features & Use Cases

  • Endpoint Coverage Validation: Verifies that all user actions and data flows are supported by corresponding API endpoints.
  • Consistency Audits: Checks for uniform naming conventions, error handling, pagination, and versioning strategies.
  • Use Case: After an architecture sketch is created for a new microservice, use this Skill to review its proposed API endpoints against user stories and domain requirements to catch any missing operations or design flaws.

Quick Start

Use the shaping-reviewing-api-contracts skill to review the API contracts for the 'user-management' architecture sketch.

Frequently Asked Questions about shaping-reviewing-api-contracts

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

FAQPage Schema
How do I validate API contracts for an architecture sketch before implementation?▼

To validate API contracts for an architecture sketch, you evaluate endpoint coverage, naming consistency, error responses, pagination, versioning, and authorization to ensure all user actions map to well-defined REST operations.

What does endpoint coverage validation check for in API design?▼

Endpoint coverage validation verifies that all user actions and data flows implied by UX flows and domain scenarios are fully supported by corresponding API operations within the architecture sketch.

Can I audit REST conventions and naming consistency for proposed microservice endpoints?▼

Yes, you can audit REST conventions and naming consistency for proposed microservice endpoints by checking for uniform naming conventions, error handling strategies, pagination, and versioning strategies.

When do I need to review API contracts against user stories and domain requirements?▼

You should review API contracts against user stories and domain requirements after creating an architecture sketch for a new microservice, ensuring you catch any missing operations or design flaws before implementation begins.

What's the best way to prevent missing API operations in architecture sketches?▼

The best way to prevent missing API operations is to validate the API contract by ensuring all user actions implied by UX flows and domain scenarios are mapped to well-defined API operations adhering to REST conventions.

Related Skills

Explore More Software Engineering Skills→
EONMUNEONMUN
1

spec_driven_development.plan

Convert clarified specifications into technical plans with architecture, data models, and API contracts.

Official
Advanced
ChoiHyunjinChoiHyunjin

role-backend-developer

Implement RESTful APIs, business logic, and data access layers from specifications.

Community
Advanced
autostay-krautostay-kr
1

test-scenarios

Generate test scenarios from user stories with objectives, conditions, roles, steps, and outcomes.

Official
Intermediate
alsmadi99alsmadi99

api-designer

Design REST and GraphQL APIs with OpenAPI 3.1 specifications.

Community
Advanced