Openapi

OpenAPI (Swagger)

NeuralBlitz Updated 1 repo stars

File contents

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

NeuralBlitz/Agent-Gateway/tree/main/agent-gateway/skills/user/categories/apis/openapi commit b4818b1bf4

Frequently asked questions

npx skillmds@latest add neuralblitz/openapi-2