This project demonstrates how to integrate Swagger for API documentation in a Fiber application using gofiber/contrib/swaggerui and swaggo/swag.

• Go 1.21+
• Swag CLI for generating Swagger docs
• PostgreSQL (connection configured via environment variables)

1. Clone the repository:

   git clone https://github.com/gofiber/recipes.git
   cd recipes/swagger

2. Install the Swag CLI:

   go install github.com/swaggo/swag/cmd/swag@latest

3. Configure the database connection via environment variables:

   export DB_USER=postgres
   export DB_PASSWORD=secret
   export DB_HOST=localhost
   export DB_NAME=books
   export DB_PORT=5432

Generate (or regenerate) the Swagger documentation from the annotations in your source code:

swag init

This writes docs/docs.go, docs/swagger.json, and docs/swagger.yaml.

go run main.go

The application starts on port 3000.

Open your browser and navigate to:

http://localhost:3000/docs/docs

The Swagger UI is served by gofiber/contrib/v3/swaggerui and reads the spec from ./docs/swagger.json.

All routes are prefixed with /api/v1.

Annotate your Fiber handler functions with Swag comments to generate docs:

// GetBookByID returns a book by ID
// @Summary Get book by ID
// @Description Get a single book by its ID
// @Tags books
// @Accept json
// @Produce json
// @Param id path int true "Book ID"
// @Success 200 {object} ResponseHTTP{data=models.Book}
// @Failure 404 {object} ResponseHTTP{}
// @Router /v1/books/{id} [get]
func GetBookByID(c fiber.Ctx) error {
    // Your code here
}

# List all books
curl http://localhost:3000/api/v1/books

# Get book by ID
curl http://localhost:3000/api/v1/books/1

# Create a book
curl -X POST http://localhost:3000/api/v1/books \
  -H "Content-Type: application/json" \
  -d '{"title":"The Go Programming Language","author":"Donovan & Kernighan"}'

# Delete a book
curl -X DELETE http://localhost:3000/api/v1/books/1

• Fiber
• gofiber/contrib/swaggerui
• Swag Documentation