common

Documentation

Overview

The commmon package provides structs and functions for external code to interact with this gateway service.

Index

• Constants
• func LoadConfig() (*viper.Viper, error)
• type ChangePortRequest
• type ManagementService
  • func NewManagementService(RuntimePath string) (ManagementService, error)
• type Route

Constants

const (
	ConfigKeyLogPath     = "gateway.LogPath"
	ConfigKeyLogSaveName = "gateway.LogSaveName"
	ConfigKeyLogFileExt  = "gateway.LogFileExt"
	ConfigKeyGatewayPort = "gateway.Port"
	ConfigKeyWWWPath     = "gateway.WWWPath"
	ConfigKeyRuntimePath = "common.RuntimePath"

	DefaultGatewayPort = "80"
)

const (
	ManagementURLFilename = "management.url"
	StaticURLFilename     = "static.url"
	APIGatewayRoutes      = "/v1/gateway/routes"
	APIGatewayPort        = "/v1/gateway/port"
)

const Version = "0.3.6"

Functions

func LoadConfig

func LoadConfig() (*viper.Viper, error)

Types

type ChangePortRequest

type ChangePortRequest struct {
	Port string `json:"port" binding:"required"`
}

type ManagementService

type ManagementService interface {
	CreateRoute(route *Route) error
	ChangePort(request *ChangePortRequest) error
}

func NewManagementService

func NewManagementService(RuntimePath string) (ManagementService, error)

type Route

type Route struct {
	Path   string `json:"path" binding:"required"`
	Target string `json:"target" binding:"required"`
}