david/supermarket-api
1
0
Fork 0
Code Issues 9 Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #19 from davidlick/documentation

Browse Source 
Update application README.md
This commit was merged in pull request #19.
This commit is contained in:
David Lick
2021-06-21 14:16:43 -04:00
committed by GitHub
parent bfcb686e8d 1d1005b7e8
commit 1723d21e56
1 changed files with 35 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+35 -1
View File
@@ -10,8 +10,42 @@ To start `supermarket-api` you will need to create an `.env` file at `cmd/api/.e
~$ cp cmd/api/example.env cmd/api/.env
```
Supermarket-API has a Makefile with commonly ran commands. To use the Makefile append the command to `make` in your terminal:
### Usage
Supermarket-API has a Makefile with commonly needed commands. To use the Makefile append the command to `make` in your terminal:
```
~$ make run
```
### Testing
To run unit tests for Supermarket-API use the included `make` command:
```
~$ make unit-test
```
To see test coverage:
```
~$ make test-coverage
```
To see a visual report of test coverage:
```
~$ make coverage-report
```
### Docker
A Dockerfile is included to allow running in ECS or GKS. Make commands are included for building and running the containers. `make docker-run` sets local development variables and should not be used for production.
## API Spec
**Method**|**Endpoint**|**Description**|**Request Body**|**Response**
:-----:|:-----|:-----|:-----|:-----
GET|/v1/produce|Return all catalogued produce.| `null`| 200 OK<br>400 Bad Request<br>500 Internal Server Error
POST|/v1/produce|Add produce items to the catalogue.|`[{"code":"string","name":"string","price":{"amount":123,"currency":"USD"}}]`|201 Created<br>400 Bad Request<br>500 Internal Server Error
GET|/v1/produce/{produceCode}|Get the produce item with the given produceCode.|`null`|200 OK<br>400 Bad Request<br>500 Internal Server Error
DELETE|/v1/produce/{produceCode}|Delete the produce item with the given produceCode.|`null`|204 No Content<br>400 Bad Request<br>500 Internal Server Error