openapi2

Documentation

Index

• func Docs(routes []*Route) (*spec.Swagger, error)
• func LogJSON(v any)
• func LogYAML(v any)
• func MarshalJSON(v interface{}) ([]byte, error)
• func MarshalYAML(v interface{}) ([]byte, error)
• func RegisterRoute(parser *swag.Parser, route *Route) error
• func SetOperation(pathItem *spec.PathItem, method string, operation *spec.Operation)
• func WriteDocs(docs *spec.Swagger, cfg *GenConfig) error
• type GenConfig
• type Route

Functions

func Docs

func Docs(routes []*Route) (*spec.Swagger, error)

func LogJSON

func LogJSON(v any)

func LogYAML

func LogYAML(v any)

func MarshalJSON

func MarshalJSON(v interface{}) ([]byte, error)

func MarshalYAML

func MarshalYAML(v interface{}) ([]byte, error)

func RegisterRoute

func RegisterRoute(parser *swag.Parser, route *Route) error

func SetOperation

func SetOperation(pathItem *spec.PathItem, method string, operation *spec.Operation)

func WriteDocs

func WriteDocs(docs *spec.Swagger, cfg *GenConfig) error

Types

type GenConfig

type GenConfig = gen.GenConfig

type Route

type Route struct {
	Method      string
	Path        string
	Params      []spec.Parameter
	Handler     http.Handler
	Middlewares []func(http.Handler) http.Handler
}