openapi
CommunityDesign and document REST APIs with OpenAPI.
Authorbswrundquist
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill streamlines the process of designing, documenting, and generating code for REST APIs using the OpenAPI 3.x specification.
Core Features & Use Cases
- API Specification: Define paths, operations, parameters, request bodies, responses, and components.
- Schema Definition: Create reusable schemas for request and response payloads, including discriminated unions.
- Security Schemes: Implement authentication and authorization mechanisms like BearerAuth, ApiKeyAuth, and OAuth2.
- API Design Principles: Adhere to best practices for URLs, HTTP methods, status codes, and naming conventions.
- Code Generation & Linting: Utilize tools to generate client code and validate specifications against best practices.
- Use Case: You need to define the API for a new microservice. Use this Skill to create a comprehensive OpenAPI 3.1.0 specification, including detailed schemas for user management and security.
Quick Start
Use the openapi skill to generate a basic OpenAPI 3.1.0 specification for a user management API.
Dependency Matrix
Required Modules
openapi-spec-validator@redocly/cli@openapitools/openapi-generator-cli
Components
referencesscripts
💻 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: openapi Download link: https://github.com/bswrundquist/devtools/archive/main.zip#openapi Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.