# Openapi

> OpenAPI (Swagger)

- Skill: `neuralblitz/openapi-2` (Agent Skill)
- Install (CLI): `npx skillmds@latest add neuralblitz/openapi-2`
- Raw SKILL.md: https://api.skillmd.com/api/skills/neuralblitz/openapi-2/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: AI & ML
- Author: NeuralBlitz (https://skillmd.com/u/neuralblitz)
- Updated: 2026-09-22
- Page: https://skillmd.com/skills/neuralblitz/openapi-2

---

# OpenAPI (Swagger)

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