Account API Client

This repository contains Go-based client for Form3 Account API.

Examples

Examples can be found in examples directory.

Testing

Following steps need to be performed in order to launch tests:

1. docker-compose up
2. make test

Coverage reports

Coverage reports can be generated by issuing following commands:

1. make coverage - generates coverage.out report file
2. make coverhtml - generates HTML coverage report in client directory.

Linting

To lint client code, go vet, gofmt and golangci-lint tools are used. issue following commands to install dependencies and execute static checks:

1. make dep
2. make lint

TODO:

1. CI/CD
2. Security checks?
3. Increase code coverage by mocking some of the API calls.
4. Logs dependency injection to AccountClient struct.
5. Performance tests?
6. Requests caching (in-memory, Redis etc.).