Swagger and OpenAPI
Generate, update, and view Swagger docs for Opensbx.
Swagger documentation is generated from Go annotations using swag.
Install Generator
go install github.com/swaggo/swag/cmd/swag@latestGenerate Docs
swag init -g ./cmd/api/main.go -o docs --parseDependency --parseInternalManual absolute-path variant:
/Users/uprizing/go/bin/swag init -g ./cmd/api/main.go -o docs --parseDependency --parseInternalRegenerate after handler annotation changes (@Summary, @Param, @Success, etc.).
Generated Artifacts
docs/docs.godocs/swagger.jsondocs/swagger.yaml
Swagger UI
With the API running:
http://localhost:8080/swagger/index.html