openapi

package
Version: v0.0.0-...-9649366 Latest Latest
Warning

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

Go to latest
Published: Nov 21, 2019 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// URL is the url for the OpenAPI handler.
	URL = handler.RoutePrefixV1 + "/openapi"

	// HTTPMethod is the HTTP method used with this resource.
	HTTPMethod = http.MethodGet
)

Variables

View Source
var (
	// StaticURLPrefix is the url prefix for openapi specs.
	StaticURLPrefix = URL + "/static/"
)

Functions

func NewDocHandler

func NewDocHandler(
	instrumentOpts instrument.Options,
) http.Handler

NewDocHandler returns a new doc handler.

func StaticHandler

func StaticHandler() http.Handler

StaticHandler is the handler for serving static assets (including OpenAPI specs).

Types

type DocHandler

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

DocHandler handles serving the OpenAPI doc.

func (*DocHandler) ServeHTTP

func (h *DocHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP serves the OpenAPI doc.

Source Files

Jump to

Keyboard shortcuts

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