echoswagger

Documentation

Index

• Variables
• func AddToSwagger(ec echo.Context) (method swagger.IMethod)
• func BuildSwagger(srv *echo.Echo, swaggerPath, address string, sw swagger.ISwaggerAPI, ...) (err error)
• func ExcludeFromSwagger(next echo.HandlerFunc) echo.HandlerFunc
• func Handler(confs ...func(c *swagger.Config)) echo.HandlerFunc
• func IsBuildingSwagger(ec echo.Context) bool

Variables

var WrapHandler = Handler()

WrapHandler wraps swaggerFiles.Handler and returns echo.HandlerFunc

Functions

func AddToSwagger

func AddToSwagger(ec echo.Context) (method swagger.IMethod)

AddToSwagger - add endpoint description to the OpenAPI Specification

func BuildSwagger

func BuildSwagger(srv *echo.Echo, swaggerPath, address string, sw swagger.ISwaggerAPI, logger *zerolog.Logger) (err error)

BuildSwagger - build the OpenAPI Specification in JSON format

func ExcludeFromSwagger

func ExcludeFromSwagger(next echo.HandlerFunc) echo.HandlerFunc

ExcludeFromSwagger - middleware for exclude swagger description for selected endpoint.

func Handler

func Handler(confs ...func(c *swagger.Config)) echo.HandlerFunc

Handler wraps `http.Handler` into `echo.HandlerFunc`.

func IsBuildingSwagger

func IsBuildingSwagger(ec echo.Context) bool

IsBuildingSwagger - mark that we build swagger description for endpoint