writing-openapi-specs

Community

Write better OpenAPI specs.

AuthorCarlosEGuerraSilva
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill helps developers write high-quality OpenAPI specifications by providing best practices, naming conventions, and guidance on expressing complex API patterns, ensuring better SDK generation and API documentation.

Core Features & Use Cases

  • Best Practices: Adheres to established conventions for naming, documentation, and reusability.
  • Complex Patterns: Guides on expressing enums, polymorphism, file uploads, and server-sent events.
  • SDK Generation: Optimizes specs for generating robust and type-safe SDKs.
  • Use Case: When designing a new API, use this Skill to ensure your OpenAPI spec is clear, consistent, and easily consumable by SDK generators.

Quick Start

Use the writing-openapi-specs skill to learn about naming conventions for OpenAPI operation IDs.

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: writing-openapi-specs
Download link: https://github.com/CarlosEGuerraSilva/OpenRouterSDK.NET/archive/main.zip#writing-openapi-specs

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