Skills
.Work. You
Rest

api-spec-writer

Community

Produce production-grade OpenAPI contracts.

Software Engineering#openapi#yaml#pagination#api contract#rfc 7807#rest design#security schemes
AuthorGustavoGutierrez
Version1.0.0
Installs0

System Documentation

What problem does it solve?

It solves the problem of turning API requirements and domain models into a complete, consistent, and machine-valid API contract.

Core Features & Use Cases

  • Design complete OpenAPI contracts: Generates OpenAPI 3.0/3.1 YAML including endpoints, schemas, security, pagination, and error handling.
  • Standardize API quality: Enforces RESTful semantics, RFC 7807 Problem Details errors, schema reuse via components, and OpenAPI structural validity checks.
  • Support contract evidence: Includes request/response examples for major success and error cases to make the spec testable and understandable.

Quick Start

Use the api-spec-writer skill to generate an OpenAPI 3.1 YAML contract for a REST API described by your endpoint requirements and data models.

Dependency Matrix

Required Modules

None required

Components

references

💻 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-spec-writer
Download link: https://github.com/GustavoGutierrez/engineering-skills/archive/main.zip#api-spec-writer

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 471,000+ vetted skills library on demand.