api

Documentation

Index

• Constants
• func StartServer(address, port string, tls bool)
• type StartServerCommand
  • func (fc *StartServerCommand) Address() string
  • func (fc *StartServerCommand) Flags() *flag.FlagSet
  • func (fc *StartServerCommand) HelpString() string
  • func (fc *StartServerCommand) Name() string
  • func (fc *StartServerCommand) Port() string
  • func (fc *StartServerCommand) Run(ctx context.Context, args []string) error
  • func (fc *StartServerCommand) Tls() bool

Constants

const (
	HealthCheckRoute = "/__health-check"
	UserRoute        = "/users"
)

Functions

func StartServer

func StartServer(address, port string, tls bool)

StartServer starts the http server

Types

type StartServerCommand

type StartServerCommand struct {
	// contains filtered or unexported fields
}

StartServerCommand is struct for info required to start an http server

func (*StartServerCommand) Address

func (fc *StartServerCommand) Address() string

Address gets the server address

func (*StartServerCommand) Flags

func (fc *StartServerCommand) Flags() *flag.FlagSet

Flags returns the flag sets

func (*StartServerCommand) HelpString

func (fc *StartServerCommand) HelpString() string

HelpString gets the string shown as usage in cli

func (*StartServerCommand) Name

func (fc *StartServerCommand) Name() string

Name gets the name of the command used in yacli package

func (*StartServerCommand) Port

func (fc *StartServerCommand) Port() string

Port gets the http server port

func (*StartServerCommand) Run

func (fc *StartServerCommand) Run(ctx context.Context, args []string) error

Run the start server command

func (*StartServerCommand) Tls

func (fc *StartServerCommand) Tls() bool

Tls gets the flag whether the server should run on TLS