micro

README

micro

Microservice prototype with gRPC + Restful + Redoc + Opentracing + Prometheus.

Documentation

Overview

ref: https://opentelemetry.io/docs/demo/services/checkout/

Index

• Constants
• type RedocOpts
• type RegisterServiceHandlerFunc
• type Service
  • func NewService() *Service
  • func (s *Service) AddService(serviceDesc *grpc.ServiceDesc, srv interface{}, ...)
  • func (s *Service) SetGRPCGatewayPort(port uint16)
  • func (s *Service) SetGRPCPort(port uint16)
  • func (s *Service) Start() error
  • func (s *Service) Stop()
  • func (s *Service) UpRedoc(up bool) *Service

Constants

const SwaggerFile = "/swagger.json"

SwaggerFile is the swagger file (local path)

Types

type RedocOpts

type RedocOpts struct {
	// SpecURL the url to find the spec for
	SpecURL string
	// RedocURL for the js that generates the redoc site, defaults to: https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js
	RedocURL string
	// Title for the documentation site, default to: API documentation
	Title string
}

RedocOpts is the Redoc configures type

var RedocOptions RedocOpts

RedocOptions configures the Redoc

type RegisterServiceHandlerFunc

type RegisterServiceHandlerFunc func(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

ReverseProxyFunc - a callback that the caller should implement to steps to reverse-proxy the HTTP/1 requests to gRPC type ReverseProxyFunc func(ctx context.Context, mux *runtime.ServeMux, grpcHostAndPort string, opts []grpc.DialOption) error

type Service

type Service struct {
	GRPCServer *grpc.Server
	// contains filtered or unexported fields
}

Service - to represent the microservice

func NewService

func NewService() *Service

NewService - to create the microservice object

func (*Service) AddService

func (s *Service) AddService(serviceDesc *grpc.ServiceDesc, srv interface{}, registerServiceHandlerFunc RegisterServiceHandlerFunc)

func (*Service) SetGRPCGatewayPort

func (s *Service) SetGRPCGatewayPort(port uint16)

func (*Service) SetGRPCPort

func (s *Service) SetGRPCPort(port uint16)

func (*Service) Start

func (s *Service) Start() error

Start - to start the microservice with listening on the ports

func (*Service) Stop

func (s *Service) Stop()

func (*Service) UpRedoc

func (s *Service) UpRedoc(up bool) *Service

UpRedoc - to configure redoc server to run up at /docs endpoint