apiserver

Documentation

Index

• func ErrChecker(err error)
• func GetDocs(ctx *fiber.Ctx)
• func GetEnv(key, fallback string) string
• func Routes(app *fiber.App)
• func ValidateConfigPath(path string) error
• type APIServer
  • func NewServer(config *Config) *APIServer
  • func (s *APIServer) Start() *fiber.App
• type Config
  • func NewConfig(configPath string) (*Config, error)

Functions

func ErrChecker

func ErrChecker(err error)

ErrChecker method for check error and show message

func GetDocs

func GetDocs(ctx *fiber.Ctx)

GetDocs will send the documents list

func GetEnv

func GetEnv(key, fallback string) string

GetEnv function for getting environment variables values, or return fallback

func Routes

func Routes(app *fiber.App)

Routes list of the available routes for project

func ValidateConfigPath

func ValidateConfigPath(path string) error

ValidateConfigPath just makes sure, that the path provided is a file, that can be read

Types

type APIServer

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

APIServer struct

func NewServer

func NewServer(config *Config) *APIServer

NewServer method for init new server instance

func (*APIServer) Start

func (s *APIServer) Start() *fiber.App

Start method for start new server

type Config

type Config struct {
	Server   server   `yaml:"server"`
	Database database `yaml:"database"`
	Static   static   `yaml:"static"`
}

Config struct for project config

func NewConfig

func NewConfig(configPath string) (*Config, error)

NewConfig returns a new decoded Config struct