apigo

An application programming interface service template.

This set of packages may be useful as a template project when creating services which expose a REST API using Go.

Requirements

• go
• docker
• make

Building and Testing

To build the service locally:

$ make clean
$ make build

To run just the unit tests, which do not start any test containers:

$ make test-quick

To run all tests, including integration tests, which start test containers:

$ make test

To start the test environment containers locally:

$ make start

To run the service locally, for testing:

$ make run

Finally, to shutdown and cleanup the test environment:

$ make stop

Documentation

While the service is running locally, interactive documentation, which can be used for testing requests to the service, can be accessed using:

• http://localhost:8080/api/v1/docs