skills.rest
hungrytech
hungrytechCOMMUNITY
Explore all skills by this author →
GitHub

sub-api-designer

Create and validate OpenAPI 3.1 contracts for REST APIs.

3|Updated Mar 30, 2026
Search Tags:#documentation#openapi#contract-first#api-design#breaking-change#mock-server#rest-patterns
One-click install
npx skills add https://github.com/hungrytech/hungrytech-claude-skills --skill sub-api-designer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sub-api-designer
Source: https://github.com/hungrytech/hungrytech-claude-skills/tree/main/plugins/sub-api-designer/skills/sub-api-designer
Command: npx skills add https://github.com/hungrytech/hungrytech-claude-skills --skill sub-api-designer

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Contract-first API design agent that generates and validates OpenAPI 3.1 specs, detects breaking changes, applies REST design patterns, and provisions mock/documentation scaffolds.

Core Features & Use Cases

  • OpenAPI 3.1 spec generation and validation
  • Breaking-change detection and versioning guidance
  • REST design pattern templates (pagination, filtering, error responses)
  • Coordination with sister skills to generate controllers and tests
  • On-demand documentation and mock server setup for API contracts

Quick Start

Analyze an existing API and generate a complete OpenAPI 3.1 contract ready for design, validation, and documentation.

Frequently Asked Questions about sub-api-designer

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

FAQPage Schema
How do I create an OpenAPI 3.1 contract from scratch?▼

To create an OpenAPI 3.1 contract, this skill analyzes your requirements and applies a phase-driven workflow of Analyze, Design, Validate, and Document to generate a complete specification. It enforces compatibility rules and standardized error responses throughout the design phase.

Does this OpenAPI designer support REST patterns like pagination and filtering?▼

Yes, this OpenAPI designer supports REST design pattern templates including standardized pagination, filtering, and error responses. These templates are applied during the design phase to ensure your API contracts follow consistent and standardized structural patterns.

Can I generate mock servers and documentation from an OpenAPI spec?▼

Yes, you can provision mock server setups and generate human-readable documentation directly from your validated API contracts. The skill coordinates with related sister skills to also generate corresponding controllers and tests for your specification.

Do I need jq installed to validate my API contracts?▼

Yes, jq is a required dependency for running the API contract validation scripts. You need this command-line JSON processor installed in your environment to execute the skill's validation and contract processing components.

Related Skills

Explore More Software Engineering Skills→
penpotpenpot
58.3k

jq-json-processor

Filter, transform, and query JSON data using jq.

Official
Intermediate
mk-knight23mk-knight23
1

api-tester

Generate and execute pytest suites from OpenAPI specs for REST APIs.

Community
Advanced
zerobearing2zerobearing2
41

using-rails-ai

Coordinate Rails development tasks using rails-ai domain skills with Superpowers workflows.

Community
Advanced
luissimon96luissimon96

graph-api-design

Audit API governance and design for OpenAPI/Swagger compliance.

Community
Advanced