route

Documentation

Overview

Package route will hold the routes and route groups

Index

• func RegisterRoutes(router *Router) error
• type Router
  • func NewRouter(opts ...RouterOption) *Router
  • func (r *Router) AddEchoOnlyRoute(pattern, method string, route echo.Routable) error
  • func (r *Router) AddRoute(pattern, method string, op *openapi3.Operation, route echo.Routable) error
  • func (r *Router) AddUnversionedRoute(pattern, method string, op *openapi3.Operation, route echo.Routable) error
  • func (r *Router) Addv1Route(pattern, method string, op *openapi3.Operation, route echo.Routable) error
  • func (r *Router) Base() *echo.Group
  • func (r *Router) VersionOne() *echo.Group
  • func (r *Router) VersionTwo() *echo.Group
• type RouterOption
  • func WithEcho(e *echo.Echo) RouterOption
  • func WithHandler(h *handlers.Handler) RouterOption
  • func WithHideBanner() RouterOption
  • func WithOpenAPI(oas *openapi3.T) RouterOption
  • func WithOptions(opts ...RouterOption) RouterOption

Functions

func RegisterRoutes

func RegisterRoutes(router *Router) error

RegisterRoutes with the echo routers - Router is defined within openapi.go

Types

type Router

type Router struct {
	Echo        *echo.Echo
	OAS         *openapi3.T
	Handler     *handlers.Handler
	StartConfig *echo.StartConfig
}

Router is a struct that holds the echo router, the OpenAPI schema, and the handler - it's a way to group these components together

func NewRouter

func NewRouter(opts ...RouterOption) *Router

NewRouter creates a new router with the echo router and OpenAPI schema

func (*Router) AddEchoOnlyRoute

func (r *Router) AddEchoOnlyRoute(pattern, method string, route echo.Routable) error

AddEchoOnlyRoute is used to add a route to the echo router without adding it to the OpenAPI schema

func (*Router) AddRoute

func (r *Router) AddRoute(pattern, method string, op *openapi3.Operation, route echo.Routable) error

AddRoute is used to add a route to the echo router and OpenAPI schema at the same time ensuring consistency between the spec and the server

func (*Router) AddUnversionedRoute

func (r *Router) AddUnversionedRoute(pattern, method string, op *openapi3.Operation, route echo.Routable) error

AddRoute is used to add a route to the echo router and OpenAPI schema at the same time ensuring consistency between the spec and the server

func (*Router) Addv1Route

func (r *Router) Addv1Route(pattern, method string, op *openapi3.Operation, route echo.Routable) error

AddRoute is used to add a route to the echo router and OpenAPI schema at the same time ensuring consistency between the spec and the server

func (*Router) Base

func (r *Router) Base() *echo.Group

Base returns the base echo group - no "version" prefix for the router group

func (*Router) VersionOne

func (r *Router) VersionOne() *echo.Group

VersionOne returns a new echo group for version 1 of the API

func (*Router) VersionTwo

func (r *Router) VersionTwo() *echo.Group

VersionTwo returns a new echo group for version 2 of the API - lets anticipate the future

type RouterOption

type RouterOption func(*Router)

func WithEcho

func WithEcho(e *echo.Echo) RouterOption

WithEcho is a RouterOption that allows the echo router to be set on the router

func WithHandler

func WithHandler(h *handlers.Handler) RouterOption

WithHandler is a RouterOption that allows the handler to be set on the router

func WithHideBanner

func WithHideBanner() RouterOption

WithHideBanner is a RouterOption that allows the banner to be hidden on the echo server

func WithOpenAPI

func WithOpenAPI(oas *openapi3.T) RouterOption

WithOpenAPI is a RouterOption that allows the OpenAPI schema to be set on the router

func WithOptions

func WithOptions(opts ...RouterOption) RouterOption

WithOptions is a RouterOption that allows multiple options to be set on the router