OpenAPI Specification (formerly Swagger) is a standard for describing REST APIs. It enables human and machine-readable documentation, code generation, and testing tools.
Key Concepts
OpenAPI document structure
Paths, operations, parameters
Request/response schemas
Security schemes
Components for reusability
Common Use Cases
API documentation
Code generation (clients, servers)
API mocking
Contract testing
Developer portals
Best Practices
Design first approach
Use OpenAPI 3.1
Include examples
Define error responses
Use references for reusability
Resources
Spec: spec.openapis.org
Swagger: swagger.io
Related Skills: rest, api-design, documentation
1---2name: openapi-23description: OpenAPI (Swagger)4---5# OpenAPI (Swagger)67OpenAPI Specification (formerly Swagger) is a standard for describing REST APIs. It enables human and machine-readable documentation, code generation, and testing tools.89## Key Concepts1011- OpenAPI document structure12- Paths, operations, parameters13- Request/response schemas14- Security schemes15- Components for reusability1617## Common Use Cases1819- API documentation20- Code generation (clients, servers)21- API mocking22- Contract testing23- Developer portals2425## Best Practices2627- Design first approach28- Use OpenAPI 3.129- Include examples30- Define error responses31- Use references for reusability3233## Resources3435- Spec: spec.openapis.org36- Swagger: swagger.io37- Related Skills: rest, api-design, documentation
Run npx skillmds@latest add neuralblitz/openapi-2 in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.
OpenAPI (Swagger) It is listed under AI & ML on SkillMD.
This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. Capability flags: docs only. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.
This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.
Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.
NeuralBlitz (@neuralblitz) published this skill. Their other Agent Skills are listed on their SkillMD profile.