routes

Documentation

Overview

Package routes holds a collection of optional genericapiserver http handlers.

Index

• type Index
  • func (i Index) Install(c *mux.APIContainer)
• type Profiling
  • func (d Profiling) Install(c *mux.APIContainer)
• type SwaggerUI
  • func (l SwaggerUI) Install(c *mux.APIContainer)
• type Version
  • func (v Version) Install(c *mux.APIContainer)

Types

type Index

type Index struct{}

Index provides a webservice for the http root / listing all known paths.

func (Index) Install

func (i Index) Install(c *mux.APIContainer)

Install adds the Index webservice to the given mux.

type Profiling

type Profiling struct{}

Profiling adds handlers for pprof under /debug/pprof.

func (Profiling) Install

func (d Profiling) Install(c *mux.APIContainer)

Install adds the Profiling webservice to the given mux.

type SwaggerUI

type SwaggerUI struct{}

SwaggerUI exposes files in third_party/swagger-ui/ under /swagger-ui.

func (SwaggerUI) Install

func (l SwaggerUI) Install(c *mux.APIContainer)

Install adds the SwaggerUI webservice to the given mux.

type Version

type Version struct{}

Version provides a webservice with version information.

func (Version) Install

func (v Version) Install(c *mux.APIContainer)

Install registers the APIServer's `/version` handler.