To run the app as dockerised image go to the root directory of where you have cloned the repo from command line/powershell/vscode terminal, etc.
-
Run below command to build an image
docker run --rm -it -p 5000:80/tcp truelayer-pokedex-service:latest
-
Run below command to run app
docker run --rm -it -p 5000:80/tcp truelayer-pokedex-service:latest
-
Access the browser on this address http://localhost:5000/swagger/ to view swagger or you can simply use the HttPie to test the API. (below we have section to show to to test using HttPie as well)
In visual studio you can open the .sln (solution file) file and set the Api project as startup as below steps:
1- Api project
2- Set as startup
3- Run the application either using IS express or Kestrel as below option (which should launch the api's swagger docs
4- Swagger docs
You can also use swagger to to the testing of the Api of can use Httpie for command line testing.
HttPie testing results as below:
You can also use vs code to run the application. Easiest way is to install docker extension and build docker image from there.
There are few improvements which I can think are important to go live with this service.
- BDD Test (specflow, cucumber, etc.)
- Add more loggin
- Add resilience (polly to check api down and circut breaker)
- Add Caching (redis cache or local storage cache)
- Authentication/Authorization (depends how sensitive data it is, P1, P2, etc.)
- CI/CD deployment using Github actions
- Rate limiter (how many http call per sec or minutes can go, etc.)