go/golang-saas-starter-kit
1
0
Fork 0
mirror of https://github.com/raseels-repos/golang-saas-starter-kit.git synced 2025-06-29 00:52:03 +02:00
Code Issues Releases Activity

Merge branch 'webapiReadmeImprovements' into 'master'

Browse Source 
webapi: README fixes and improvements

See merge request geeks-accelerator/oss/saas-starter-kit!12
This commit is contained in:
Lee Brown
2019-08-20 05:08:49 +00:00
parent 4f95d991d1 4e15b6671b
commit 869a999e8a
1 changed files with 29 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
cmd/web-api/README.md
View File

@ -29,7 +29,7 @@ separation should help decouple client integrations from internal application de
## Making Requests to Web API ## Making Requests to Web API
Once the web-api service is running it will be available on port 3000. Once the web-api service is running it will be available on port 3001.
http://127.0.0.1:3001/ http://127.0.0.1:3001/
The easiest way to make requests to the web-api service is by using CURL via your CLI. The easiest way to make requests to the web-api service is by using CURL via your CLI.
@ -63,7 +63,9 @@ go build .
### Docker ### Docker
To build using the docker file, need to be in the project root directory. `Dockerfile` references go.mod in root directory. To build using the docker file you need to be in the project root directory.
The `Dockerfile` assumes the working context is the root directory since it references Go Module
files to build the image.
```bash ```bash
@ -73,7 +75,7 @@ docker build -f cmd/web-api/Dockerfile -t saas-web-api .
## Getting Started ## Getting Started
###1. Ensure dependant services are running. ### 1. Ensure dependant services are running.
Navigate to the project root where `docker-compose.yaml` exists. There is only Navigate to the project root where `docker-compose.yaml` exists. There is only
one `docker-compose.yaml` file that is shared between all services. one `docker-compose.yaml` file that is shared between all services.
@ -83,44 +85,46 @@ one `docker-compose.yaml` file that is shared between all services.
docker-compose up -d docker-compose up -d
``` ```
1.1. Set env variables. #### 1.1. Set env variables.
*Copy the sample file to make your own copy.* Copy the sample file to make your own copy:
```bash ```bash
cp sample.env local.env cp sample.env local.env
``` ```
*Make any changes to your copy of the file if necessary and then add them to your env. Make any changes to your copy of the file if necessary and then add them to your env:
```bash ```bash
source local.env source local.env
``` ```
1.2. Start the web-api service. #### 1.2. Start the web-api service.
*Invoke main.go directly or use `go build .`* Invoke main.go directly or use `go build .`:
```bash ```bash
go run main.go go run main.go
``` ```
###2. Initialize the MySQL database. ### 2. Initialize the MySQL database.
When `docker-compose up` if first ran, as discussed in the main readme, the database is created but does not include When `docker-compose up` is first ran, as discussed in the main readme,
any schema. the database is created but does not include any schema.
Thus, you need to use the project's schema tool to initialize the database. To do this navigate the the tools/schema Thus, you need to use the project's schema tool to initialize the database.
folder. Add the source to your env. Then run the `main.go` file for schema. To do this navigate to the `tools/schema` folder. Add the source to your env. Then run the `main.go` file for schema.
```bash ```bash
cd tools/schema/ cd tools/schema/
source sample.env source sample.env
go run main.go go run main.go
``` ```
Notice that if you run `main.go` again, you should see in the output than
all migrations `already ran` (as expected).
###3. Open the Swagger UI. ### 3. Open the Swagger UI.
Navigate your browser to [http://127.0.0.1:3001/docs](http://127.0.0.1:3001/docs). Navigate your browser to [http://127.0.0.1:3001/docs](http://127.0.0.1:3001/docs).
###4. Signup a new account. ### 4. Signup a new account.
Find the `signup` endpoint in the Swagger UI. Find the `signup` endpoint in the Swagger UI.
@ -190,36 +194,37 @@ If successful, data should be returned for code 201 for created.
Now you will now be able to use the email and password credentials to generate an auth token with the web-api service. Now you will now be able to use the email and password credentials to generate an auth token with the web-api service.
*Note: if Swagger `Try it out` response is `TypeError: Failed to fetch`, you probably accesed the swagger webpage via `http://localhost:3001/docs`. This would lead to a CORS error. You should open `http://127.0.0.1:3001/docs`*
###5. Generate an Auth Token
### 5. Generate an Auth Token
An auth token is required for all other requests. An auth token is required for all other requests.
Near the top of the Swagger UI locate the button `Authorize` and click it. Near the top of the Swagger UI locate the button `Authorize` and click it.
Find the section `OAuth2Password (OAuth2, password)` Find the section `OAuth2Password (OAuth2, password)`
Enter the user email and password. In `username` and `password` field fill the `email` value and `password` used in the signup process respectively.
Be careful that Swagger UI generates a random email in the signup process, it isn't the same as in section 4.
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. Click the button `Authorize` to generate a token that will be used by the Swagger UI for all future requests.
###6. Test Auth Token ### 6. Test Auth Token
Now that the Swagger UI is authorized, try running endpoint using the oauth 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. Find the endpoint GET `/accounts/{id}` endpoint in the Swagger UI.
Click `Try it out` and enter the account ID from generated from signup (step 5). Click `Try it out` and enter the account ID from generated from signup (step 5).
Click `Execute`. The response should be of an Account. Click `Execute`. The response should be of an Account.
###Authenticating Directly with Web API ### Authenticating Directly with Web API
If you want to authenticate directly with this web-api service and not via the Swagger UI, use the following steps. If you want to authenticate directly with this web-api service and not via the Swagger UI, use the following steps.
####1. Authenticating #### 1. Authenticating
Before any authenticated requests can be sent you must acquire an auth token. Make a request using HTTP Basic auth with Before any authenticated requests can be sent you must acquire an auth token. Make a request using HTTP Basic auth with
your email and password to get an auth token. your email and password to get an auth token.
@ -228,7 +233,7 @@ your email and password to get an auth token.
curl --user "twin@example.com:SecretString" -X POST http://127.0.0.1:3001/v1/oauth/token curl --user "twin@example.com:SecretString" -X POST http://127.0.0.1:3001/v1/oauth/token
``` ```
It is best to put the resulting token in an environment variable like `$TOKEN`. It is best to put the resulting token in an environment variable like `$TOKEN`. Notice that security tokens have an `expiry` date.
####2. Adding Token as Environment Variable ####2. Adding Token as Environment Variable