apidoc

package
v0.6.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 15, 2023 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package apidoc contains a middleware to serve the OpenAPI document.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Install

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

Install the several endpoints to serve the openapi document for g.

Types

type Operation

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

Operation is the operation to serve the OpenAPI document.

func (*Operation) Handle

func (op *Operation) Handle(p params) res

Handle implements the goapi.OperationHandler interface.

func (*Operation) OpenAPI

OpenAPI implements the goapi.OperationOpenAPI interface.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL