golang-gin-swagger
golang-gin-swagger — Swagger/OpenAPI Documentation
Generate and serve Swagger/OpenAPI documentation for Gin APIs using swaggo/swag. This skill covers the 80% you need daily: setup, handler annotations, model tags, Swagger UI, and doc generation.
When to Use
- Adding Swagger/OpenAPI documentation to a Gin API
- Documenting endpoints with request/response schemas
- Serving Swagger UI for interactive API exploration
- Generating
swagger.json/swagger.yamlfrom Go annotations - Documenting JWT Bearer auth in OpenAPI spec
- Setting up CI/CD to validate docs are up to date
Quick Reference
Dependencies
go install github.com/swaggo/swag/cmd/swag@latest— CLI doc generatorgo get -u github.com/swaggo/gin-swagger+go get -u github.com/swaggo/files- Ensure
$(go env GOPATH)/binis in$PATH
More from henriqueatila/golang-gin-best-practices
golang-gin-api
Build REST APIs with Go Gin. Use when creating Go web servers, adding Gin routes, writing handlers, or asking about middleware, binding, error handling, or project structure.
78golang-gin-database
PostgreSQL integration for Go Gin with GORM/sqlx. Use when adding a database, writing queries, creating repositories, running migrations, or wiring DB layers in a Gin project.
31golang-gin-auth
JWT auth and RBAC for Go Gin APIs. Use when adding login, signup, JWT tokens, role checks, protected routes, or password hashing to a Gin app.
27golang-gin-testing
Test Go Gin APIs with httptest, table-driven tests, testcontainers. Use when writing tests for Gin handlers, services, middleware, or setting up integration and e2e tests.
24golang-gin-psql-dba
PostgreSQL DBA for Go Gin APIs. Use when designing schemas, analyzing migrations, choosing indexes, optimizing queries, or selecting extensions (pgvector, PostGIS, TimescaleDB).
22golang-gin-architect
Software architect for Go Gin APIs. Use when making architecture decisions, evaluating complexity, designing systems, choosing patterns, or coordinating across gin skills.
21