Does it include security definitions?

Yes, it provides standardized templates for Bearer tokens, API keys, and other common security schemes within the components section of the spec.

Can I use this for existing APIs?

Absolutely. The skill supports code-first and hybrid approaches to generate or update specifications based on your existing implementation and annotations.

How does it handle error responses?

It includes reusable response templates for common HTTP status codes like 400 (Bad Request), 401 (Unauthorized), and 429 (Rate Limited) to ensure consistent error handling.

Does this skill support OpenAPI 3.1?

Yes, it is specifically designed to handle the OpenAPI 3.1.0 specification, including its advanced schema features and JSON Schema integration.

OpenAPI Spec Generation

Name: OpenAPI Spec Generation
Author: gwickman

bygwickman

0•

API 开发

Generates and maintains comprehensive OpenAPI 3.1 specifications for RESTful APIs to ensure contract compliance and documentation accuracy.

This skill empowers developers to create, validate, and maintain high-quality API documentation using the OpenAPI 3.1 standard. Whether following a design-first approach to define contracts before implementation or a code-first approach to document existing services, it provides standardized patterns for paths, schemas, security schemes, and reusable components. It streamlines the creation of client SDKs and API portals while ensuring that implementation details remain synchronized with the formal specification and business requirements.

主要功能

01Standardized templates for complex CRUD operations and pagination

02Robust schema definitions with validation patterns and reusable components

030 GitHub stars

04Support for both design-first and code-first API development workflows

05OpenAPI 3.1 compliant specification generation and maintenance

06Built-in patterns for security schemes, error handling, and rate limiting

使用场景

01Designing new RESTful API contracts with a design-first methodology

02Standardizing API response structures and error handling across multiple microservices

03Generating documentation and client SDKs from existing backend codebases

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add gwickman/auto-dev-test-target-1 openapi-spec-generation

For use in Claude.ai and ChatGPT

Download Skill