server

README

Server

server package provide a common server http.

Requirements

Golang 1.12.4 or higher

download the package:

go get -u github.com/ymohl-cl/gopkg/server

environment variables:

export MYAPP_SSL_ENABLE="true"
export MYAPP_SSL_CERTIFICATE="path_to_certificats/cert.pem"
export MYAPP_SSL_KEY="path_to_key/key.pem"
export MYAPP_PORT="4242"

Usage

import "github.com/ymohl-cl/gopkg/server"

func main() {
    s, err := server.New("myapp")
    if err != nil {
        panic(err)
    }
    if err = s.Start(); err != nil {
        panic(err)
    }
}

Changelog

v1.0.0

Initial commit

• server http with tls in option
• implement ping default route
• logs activity is on by default
• tests and documentation

Documentation

Index

• func Ping(c echo.Context) error
• type Config
  • func NewConfig(appName string) (Config, error)
• type ModelPong
• type Server
  • func New(appName string) (Server, error)
  • func (s Server) Start() error
  • func (s Server) SubRouter(prefix string) *echo.Group

Functions

func Ping

func Ping(c echo.Context) error

Ping method http GET

Types

type Config

type Config struct {
	SSL  ssl    `split_words:"true" required:"true"`
	Port string `split_words:"true" required:"true"`
}

Config support to the server

func NewConfig

func NewConfig(appName string) (Config, error)

NewConfig parse the environment values to return a initialized configuration

type ModelPong

type ModelPong struct {
	Pong bool `json:"pong"`
}

ModelPong describe the response http to a ping method

type Server

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

Server component

func New

func New(appName string) (Server, error)

New server http

func (Server) Start

func (s Server) Start() error

Start run the server

func (Server) SubRouter

func (s Server) SubRouter(prefix string) *echo.Group

SubRouter return with the prefix path specified on parameter