api

package

v0.0.0-...-864ad74 Latest Latest Go to latest Published: Jan 19, 2023 License: MIT Imports: 20 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package api provides the web interface

Package api provides the web interface

This section is empty.

This section is empty.

func NewResponseWriter(w http.ResponseWriter) *responseWriter

func Run()

Run starts to listen on web and grpc ports

type Config struct {
	Models data.Models
}

func (app *Config) GrpcListen(grpcPort string)

func (app *Config) Routes() http.Handler

Routes is the api entrypoint

func (app *Config) WriteLog(w http.ResponseWriter, r *http.Request)

WriteLog accepts json post requests and writes to mongo

type JSONPayload struct {
	Name string `json:"name"`
	Data string `json:"data"`
}

JSONPayload is the type for json posted to this api

type LogServer struct {
	pb.UnimplementedLogServiceServer
	Models data.Models
}

LogServer is type used for writing to the log via gRPC

func (l *LogServer) WriteLog(ctx context.Context, req *pb.LogRequest) (*pb.LogResponse, error)

WriteLog writes the log after receiving a call from a gRPC client