Not all CRUD methods are exposed as endpoints. Only endpoints that clients may need should be exposed. Internal services should communicate directly with the business logic packages or a new API should be created to support. This separation should help decouple client integrations from internal application development.

Local Installation

Build

go build .

Docker

To build using the docker file, need to be in the project root directory. Dockerfile references go.mod in root directory.

docker build -f cmd/web-api/Dockerfile -t saas-web-api .

Getting Started

Ensure postgres is running.

Navigate to the project root where docker-compose.yaml exists. There is only one docker-compose.yaml file that is shared between all services.

Start Postgres.
```
docker-compose up -d postgres
```
Set env variables.

Copy the sample file to make your own copy.
```
cp sample.env local.env
```
*Make any changes to your copy of the file if necessary and then add them to your env.
```
source local.env
```
Start the web-api service.

Invoke main.go directly or use go build .
```
go run main.go
```
Open the Swagger UI.

Navigate your browser to http://localhost:3000/swagger.

Signup a new account.

Find the signup endpoint in the Swagger UI.

Click Try it out. Example data has been prepopulated to generate a valid POST request.

{
  "account": {
    "address1": "221 Tatitlek Ave",
    "address2": "Box #1832",
    "city": "Valdez",
    "country": "USA",
    "name": "Company 895ff280-5ed9-4b09-b7bc-86ab0f0951d4",
    "region": "AK",
    "timezone": "America/Anchorage",
    "zipcode": "99686"
  },
  "user": {
    "email": "90873f61-663e-43d1-8f0c-00415e73f650@example.com",
    "name": "Gabi May",
    "password": "SecretString",
    "password_confirm": "SecretString"
  }
}

Note the user email and password from the request to be used in the following steps.

Click Execute and a response with status code 200 should have been returned.

{
  "account": {
    "id": "baae6e0d-29ae-456f-9648-44c1e90ca8af",
    "name": "Company 895ff280-5ed9-4b09-b7bc-86ab0f0951d4",
    "address1": "221 Tatitlek Ave",
    "address2": "Box #1832",
    "city": "Valdez",
    "region": "AK",
    "country": "USA",
    "zipcode": "99686",
    "status": "active",
    "timezone": "America/Anchorage",
    "signup_user_id": {
      "String": "bfdc5ca9-872c-4417-8030-e1b4962a107c",
      "Valid": true
    },
    "billing_user_id": {
      "String": "bfdc5ca9-872c-4417-8030-e1b4962a107c",
      "Valid": true
    },
    "created_at": "2019-06-25T11:00:53.284Z",
    "updated_at": "2019-06-25T11:00:53.284Z"
  },
  "user": {
    "id": "bfdc5ca9-872c-4417-8030-e1b4962a107c",
    "name": "Gabi May",
    "email": "90873f61-663e-43d1-8f0c-00415e73f650@example.com",
    "timezone": "America/Anchorage",
    "created_at": "2019-06-25T11:00:53.284Z",
    "updated_at": "2019-06-25T11:00:53.284Z"
  }
}

Generate an Auth Token

An auth token is required for all other requests.

Near the top of the Swagger UI locate the button Authorize and click it.

Find the section OAuth2Password (OAuth2, password)

Enter the user email and password.

Change the type to basic auth

Click the button Authorize to generate a token that will be used by the Swagger UI for all future requests.
Test Auth Token

Now that the Swagger UI is authorized, try running endpoint using the oauth token.

Find the endpoint GET /accounts/{id} endpoint in the Swagger UI. This endpoint should return the account by ID.

Click Try it out and enter the account ID from generated from signup (step 5).

Click Execute. The response should be of an Account.

API Documentation

Documentation is generated using swag

Download swag by using:

go get -u github.com/swaggo/swag/cmd/swag

Run swag init in the service's root folder which contains the main.go file. This will parse your comments and generate the required files (docs folder and docs/docs.go).

swag init

Trouble shooting

If you run into errors running swag init try the following:

cannot find package

Try to install the packages to your $GOPATH.

GO111MODULE=off go get github.com/leodido/go-urn
GO111MODULE=off go get github.com/lib/pq/oid
GO111MODULE=off go get  github.com/lib/pq/scram
GO111MODULE=off go get github.com/tinylib/msgp/msgp
GO111MODULE=off go get gopkg.in/DataDog/dd-trace-go.v1/ddtrace

error writing go.mod

Need to update pkg directory permissions.

Full error:

error writing go.mod: open /Users/leebrown/go/pkg/mod/github.com/lib/pq@v1.1.1/go.mod691440060.tmp: permission denied

Ensure the pkg directory used for go module cache has the correct permissions.

sudo chown -R $(whoami):staff ${HOME}/go/pkg
sudo chmod -R 755 ${HOME}/go/pkg