open-swaggo Documentation

A Go library to generate OpenAPI 3 / Swagger 2 specifications directly from your source code annotations — no runtime overhead, idiomatic Go, and compatible with any HTTP framework.

What You'll Find Here

This documentation walks you through every layer of open-swaggo — from installing the CLI and writing your first annotations, to generating production-grade OpenAPI specs for complex Go services.

• Annotation-Driven GenerationAdd concise comment directives above your Go handlers to describe routes, parameters, and responses — open-swaggo parses them into a complete OpenAPI spec.
• Zero Runtime OverheadSpecs are generated at build time as static JSON/YAML files — nothing runs in your hot path, and you ship the same binary to production.
• Framework-AgnosticFirst-class adapters for Gin, Echo, Fiber, Chi, and net/http — drop it into an existing codebase without refactoring your router.
• Powerful CLIA single open-swaggo init scaffolds config; open-swaggo gen produces both Swagger UI-ready JSON and OpenAPI 3.1 YAML on every build.

Add open-swaggo to your project with a single go install command. No extra configuration needed.

go install github.com/gopackx/open-swag-go@latestopen-swaggo initopen-swaggo gen ./...