middleware

Documentation

Index

• func EncodingFilter(req *restful.Request, resp *restful.Response, chain *restful.FilterChain)
• func NewOpenAPIService(config restfulspec.Config) *restful.WebService
• func SwaggerObject(swo *spec.Swagger)
• type OpenAPIService
  • func (o *OpenAPIService) UpdateSpec(openapiSpec *spec.Swagger) (err error)

Functions

func EncodingFilter

func EncodingFilter(req *restful.Request, resp *restful.Response, chain *restful.FilterChain)

EncodingFilter Route Filter (defines FilterFunction)

func NewOpenAPIService

func NewOpenAPIService(config restfulspec.Config) *restful.WebService

NewOpenAPIService returns a new WebService that provides the API documentation of all services conform the OpenAPI documentation specifcation.

func SwaggerObject

func SwaggerObject(swo *spec.Swagger)

SwaggerObject is to add more information to the swagger object

Types

type OpenAPIService

type OpenAPIService struct {
	// contains filtered or unexported fields
}

OpenAPIService is the service responsible for serving OpenAPI spec. It has the ability to safely change the spec while serving it.

func (*OpenAPIService) UpdateSpec

func (o *OpenAPIService) UpdateSpec(openapiSpec *spec.Swagger) (err error)