servicebase

README

NOT MEANT TO BE USED

This is just a place I am testing some mongo modules I am putting together. I use this to rapidly onboard go based apps for kubernetes use. Very alpha very incomplete but i'll be adding more to t and cleaning things up. Not meant for prod use just demo boilerplate stuff.

Table of Contents

• General Usage

General Usage

import (
  serviceBase "github.com/axodevelopment/servicebase"
)


func main() {

  var svc *serviceBase.Service

  svc, _ = serviceBase.New("AirportApp", serviceBase.WithPort(9091), serviceBase.WithHealthProbe(true))


	/*
    Do whatever you want
  */

  svc.AppHealthz = true
  svc.AppReadyz = true

	//start the backend
	go func(s *serviceBase.Service) {
		serviceBase.Start(s)
	}(svc)

	<-svc.ExitAppChan
}

Goal here is this will wrap up GIN and health / ready probes etc so you can just to get to making routes etc.

func createAirportRoutes(svc *serviceBase.Service) {
	svc.GinEngine.GET("/route", func(ctx *gin.Context) {

		/// do stuff
    ctx.JSON(http.StatusOK, data)

	})
}

Documentation

Index

• func Start(svc *Service)
• type Option
  • func WithCORS(enable bool) Option
  • func WithHealthProbe(healthProbe bool) Option
  • func WithPort(port int) Option
  • func WithVersion(version int) Option
• type Service
  • func New(name string, options ...Option) (*Service, error)

Functions

func Start

func Start(svc *Service)

Types

type Option

type Option func(*Service)

func WithCORS

func WithCORS(enable bool) Option

func WithHealthProbe

func WithHealthProbe(healthProbe bool) Option

func WithPort

func WithPort(port int) Option

func WithVersion

func WithVersion(version int) Option

type Service

type Service struct {
	//public
	Name        string          `json:"Name"`
	Port        int             `json:"Port"`
	HealthProbe bool            `json:"HealthProbe"`
	ExitAppChan <-chan struct{} `json:"-"`
	GinEngine   *gin.Engine     `json:"-"`
	AppHealthz  bool            `json:"AppHealthz"`
	AppReadyz   bool            `json:"AppReadyz"`
	Version     int             `json:"Version"`
	CORSEnabled bool            `json:"CorsEnabled"`
	// contains filtered or unexported fields
}

func New

func New(name string, options ...Option) (*Service, error)