openapi

Documentation

Index

• Constants
• Variables
• func NewDocHandler(instrumentOpts instrument.Options) http.Handler
• func StaticHandler() http.Handler
• type DocHandler
  • func (h *DocHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

Constants

const (
	// URL is the url for the OpenAPI handler.
	URL = route.Prefix + "/openapi"

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

Variables

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.