apidoc

package

v0.6.6 Latest Latest Go to latest Published: Sep 18, 2023 License: MIT Imports: 7 Imported by: 0

Details

Package apidoc contains a middleware to serve the OpenAPI document.

This section is empty.

This section is empty.

func Install(g *goapi.Group, config func(doc *openapi.Document) *openapi.Document)

Install the several endpoints to serve the openapi document for g. If config can be nil if you don't want to modify the generated doc.

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

Operation is the operation to serve the OpenAPI document.

func (op *Operation) Handle(p params, r *http.Request) res

Handle implements the goapi.OperationHandler interface.

func (*Operation) OpenAPI(doc openapi.Operation) openapi.Operation

OpenAPI implements the goapi.OperationOpenAPI interface.