api

Documentation

Overview

Package api provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version v1.12.4 DO NOT EDIT.

Index

• func GetSwagger() (swagger *openapi3.T, err error)
• func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
• func RegisterHandlers(router EchoRouter, si ServerInterface)
• func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)
• type EchoRouter
• type RouteService
  • func NewRouteService() *RouteService
  • func (s *RouteService) GetHealth(ctx echo.Context) error
  • func (s *RouteService) GetRoute(ctx echo.Context, id string) error
  • func (s *RouteService) GetRoutes(ctx echo.Context, params models.GetRoutesParams) error
• type ServerInterface
• type ServerInterfaceWrapper
  • func (w *ServerInterfaceWrapper) GetHealth(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) GetRoute(ctx echo.Context) error
  • func (w *ServerInterfaceWrapper) GetRoutes(ctx echo.Context) error

Functions

func GetSwagger

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func PathToRawSpec

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

func RegisterHandlers

func RegisterHandlers(router EchoRouter, si ServerInterface)

RegisterHandlers adds each server route to the EchoRouter.

func RegisterHandlersWithBaseURL

func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL string)

Registers handlers, and prepends BaseURL to the paths, so that the paths can be served under a prefix.

Types

type EchoRouter

type EchoRouter interface {
	CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
}

This is a simple interface which specifies echo.Route addition functions which are present on both echo.Echo and echo.Group, since we want to allow using either of them for path registration

type RouteService

type RouteService struct {
	Routes        []models.Route
	PrivateRoutes []models.Route
}

func NewRouteService

func NewRouteService() *RouteService

func (*RouteService) GetHealth

func (s *RouteService) GetHealth(ctx echo.Context) error

func (*RouteService) GetRoute

func (s *RouteService) GetRoute(ctx echo.Context, id string) error

func (*RouteService) GetRoutes

func (s *RouteService) GetRoutes(ctx echo.Context, params models.GetRoutesParams) error

type ServerInterface

type ServerInterface interface {
	// Health check endpoint for Kubernetes
	// (GET /health)
	GetHealth(ctx echo.Context) error
	// Request all the KongAir routes
	// (GET /routes)
	GetRoutes(ctx echo.Context, params GetRoutesParams) error
	// Request a specific KongAir route by id (LHR-SIN)
	// (GET /routes/{id})
	GetRoute(ctx echo.Context, id string) error
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) GetHealth

func (w *ServerInterfaceWrapper) GetHealth(ctx echo.Context) error

GetHealth converts echo context to params.

func (*ServerInterfaceWrapper) GetRoute

func (w *ServerInterfaceWrapper) GetRoute(ctx echo.Context) error

GetRoute converts echo context to params.

func (*ServerInterfaceWrapper) GetRoutes

func (w *ServerInterfaceWrapper) GetRoutes(ctx echo.Context) error

GetRoutes converts echo context to params.