api

Documentation

Index

• func ConfigureRouter(debug bool) *gin.Engine
• type API
• type APIOption
  • func WithGroup(group string) APIOption
  • func WithHost(host string) APIOption
  • func WithPort(port uint) APIOption
• type APIRouteRegistrar
• type APIv1
  • func GetInstance() *APIv1
  • func New(debug bool, options ...APIOption) *APIv1
  • func (a *APIv1) AddRoute(method, path string, handler gin.HandlerFunc)
  • func (a *APIv1) Engine() *gin.Engine
  • func (a *APIv1) Start() error

Functions

func ConfigureRouter

func ConfigureRouter(debug bool) *gin.Engine

Types

type API

type API interface {
	Start() error
	AddRoute(method, path string, handler gin.HandlerFunc)
}

type APIOption

type APIOption func(*APIv1)

func WithGroup

func WithGroup(group string) APIOption

func WithHost

func WithHost(host string) APIOption

func WithPort

func WithPort(port uint) APIOption

type APIRouteRegistrar

type APIRouteRegistrar interface {
	RegisterRoutes()
}

type APIv1

type APIv1 struct {
	ApiGroup *gin.RouterGroup
	Host     string
	Port     uint
	// contains filtered or unexported fields
}

func GetInstance

func GetInstance() *APIv1

func New

func New(debug bool, options ...APIOption) *APIv1

func (*APIv1) AddRoute

func (a *APIv1) AddRoute(method, path string, handler gin.HandlerFunc)

func (*APIv1) Engine

func (a *APIv1) Engine() *gin.Engine

func (*APIv1) Start

func (a *APIv1) Start() error

@license.name Apache 2.0 @license.url http://www.apache.org/licenses/LICENSE-2.0.html