README
¶
sysl-go
Communication library used by SYSL-generated code written in Go.
1.1. Getting Started
Go get the repository
go get github.com/anz-bank/sysl-go
Use docker
docker pull anzbank/sysl-go:latest
docker run --rm -v $(pwd):/mount:ro anzbank/sysl-go /sysl-go/codegen/arrai/service.arrai github.com/anz-bank/sysl-template/gen /mount/api/project.json simple rest-app | tar xf - -C gen/simple
See sysl-template for more examples
1.1.1. Local Development
1.1.2. Prerequisites
Ensure your environment provides:
- go 1.14
- golangci-lint 1.29.0
- protobuf 3.11.4
make- proto3 and gRPC
sysltool available on PATHarraitool available on PATH
On OSX, after installing go 1.14 run
brew install golangci/tap/golangci-lint make curl protoc-gen-go grpc
1.1.3 Development
Test and lint everything with
make
View all relevant make targets with
make help
View test coverage in the browser with
make coverage
Directories
¶
| Path | Synopsis |
|---|---|
|
codegen
|
|
|
Package jsontime gives simple marshalling directly to and from time objects This is a simple package that provides wrapper types for time.Time and time.Duration that can be marshalled to and from json and yaml.
|
Package jsontime gives simple marshalling directly to and from time objects This is a simple package that provides wrapper types for time.Time and time.Duration that can be marshalled to and from json and yaml. |
|
Package jwtauth manages request authentication with jwts This module provides a simple API to manage authentication and authorization with JWTs (JSON Web Token).
|
Package jwtauth manages request authentication with jwts This module provides a simple API to manage authentication and authorization with JWTs (JSON Web Token). |
|
Package mock contains testing utilities and mocks shared between packages.
|
Package mock contains testing utilities and mocks shared between packages. |
Click to show internal directories.
Click to hide internal directories.