fiberSwagger

README

fiber-swagger

fiber middleware to automatically generate RESTful API documentation with Swagger 2.0.

Usage

Start using it

1. Add comments to your API source code, See Declarative Comments Format.
2. Download Swag for Go by using:

$ go get github.com/swaggo/swag/cmd/swag

1. Run the Swag in your Go project root folder which contains main.go file, Swag will parse comments and generate required files(docs folder and docs/doc.go).

$ swag init

1. Download fiber-swagger by using:

$ go get -u github.com/swaggo/fiber-swagger

And import following in your code:

import "github.com/swaggo/fiber-swagger" // fiber-swagger middleware

Canonical example:

package main

import (
	"log"

	"github.com/gofiber/fiber/v2"
	"github.com/swaggo/fiber-swagger"

	_ "github.com/swaggo/fiber-swagger/example/docs" // docs is generated by Swag CLI, you have to import it.
)

// @title Swagger Example API
// @version 1.0
// @description This is a sample server Petstore server.
// @termsOfService http://swagger.io/terms/

// @contact.name API Support
// @contact.url http://www.swagger.io/support
// @contact.email support@swagger.io

// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html

// @host petstore.swagger.io
// @BasePath /v2
func main() {
	app := fiber.New()

	app.Get("/swagger/*", fiberSwagger.WrapHandler)

	err := app.Listen(":1323")
	if err != nil {
		log.Fatalf("fiber.Listen failed %s",err)
	}
}

1. Run it, and browser to http://localhost:1323/swagger/index.html, you can see Swagger 2.0 Api documents.

Documentation

Index

• Variables
• func DeepLinking(deepLinking bool) func(c *Config)
• func DocExpansion(docExpansion string) func(c *Config)
• func DomID(domID string) func(c *Config)
• func FiberWrapHandler(configFns ...func(c *Config)) fiber.Handler
• func InstanceName(name string) func(*Config)
• func PersistAuthorization(persistAuthorization bool) func(c *Config)
• func URL(url string) func(c *Config)
• type Config

Variables

var WrapHandler = FiberWrapHandler()

WrapHandler wraps swaggerFiles.Handler and returns echo.HandlerFunc

Functions

func DeepLinking

func DeepLinking(deepLinking bool) func(c *Config)

DeepLinking true, false.

func DocExpansion

func DocExpansion(docExpansion string) func(c *Config)

DocExpansion list, full, none.

func DomID

func DomID(domID string) func(c *Config)

DomID #swagger-ui.

func FiberWrapHandler

func FiberWrapHandler(configFns ...func(c *Config)) fiber.Handler

FiberWrapHandler wraps `http.Handler` into `fiber.Handler`.

func InstanceName

func InstanceName(name string) func(*Config)

InstanceName set the instance name that was used to generate the swagger documents Defaults to swag.Name ("swagger").

func PersistAuthorization

func PersistAuthorization(persistAuthorization bool) func(c *Config)

PersistAuthorization Persist authorization information over browser close/refresh. Defaults to false.

func URL

func URL(url string) func(c *Config)

URL presents the url pointing to API definition (normally swagger.json or swagger.yaml).

Types

type Config

type Config struct {
	// The url pointing to API definition (normally swagger.json or swagger.yaml). Default is `mockedSwag.json`.
	URL                  string
	InstanceName         string
	DocExpansion         string
	DomID                string
	DeepLinking          bool
	PersistAuthorization bool
}

Config stores echoSwagger configuration variables.