Will it help with API consistency?

Yes, it enforces best practices such as kebab-case for paths and reusable schema references to ensure a uniform developer experience across your entire API.

Does this skill support the latest OpenAPI versions?

Yes, it is specifically designed to generate specifications aligned with OpenAPI 3.0.3 and 3.1.0 standards.

Can it generate examples for my documentation?

Yes, one of its core principles is providing extensive, realistic data examples for both requests and responses to make the documentation more actionable.

Can I use this for existing API codebases?

Absolutely. You can provide your current endpoint logic or raw JSON/YAML, and the skill will refine it into a well-structured, compliant specification.

Does it handle security and authentication schemas?

Yes, it provides boilerplate and custom configurations for Bearer tokens, API keys, and other common security definitions within the components section.

OpenAPI Documentation Expert

Name: OpenAPI Documentation Expert
Author: dengineproblem

bydengineproblem

0•

API開発

Generates comprehensive, standard-compliant OpenAPI and Swagger specifications for production-grade RESTful APIs.

This skill acts as a specialized consultant for architecting and documenting APIs using OpenAPI 3.0+ standards. It ensures high-quality documentation by enforcing consistent naming conventions, defining reusable component schemas, and including detailed business logic context, error scenarios, and realistic data examples. Whether you are starting a new API design or documenting an existing backend service, this skill helps create robust specifications that are ready for client-side code generation, automated testing, and developer portals like Swagger UI.

主な機能

01Automates the creation of reusable component schemas and security definitions

02Includes realistic examples for complex request and response bodies to improve developer experience

03Standardizes API specs using OpenAPI 3.0.3 and 3.1.0 protocols

040 GitHub stars

05Enforces consistent naming conventions like kebab-case paths and camelCase properties

06Generates comprehensive error responses, validation scenarios, and rate-limiting documentation

ユースケース

01Designing a new REST API from scratch using a 'Design-First' documentation approach

02Standardizing API response formats and error handling structures across a microservices architecture

03Documenting existing legacy endpoints to create a unified and interactive Swagger UI

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add dengineproblem/agents-monorepo openapi-documentation

For use in Claude.ai and ChatGPT

Download Skill