thepra/Pokespearean
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Adding wanted improvements section in README

Browse Source
This commit is contained in:
Eugene ;) 2020-11-22 20:01:37 +01:00
parent a9b4f9256a
commit 729dafb3b3
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -16,3 +16,8 @@ The first 2 profiles will run the project directly(clicking on the green play bu
In this case you need to add to the path "/pokemon/{pokemon name}" where instead of `{pokemon name}` you need write the name of the pokemon, if the pokemon is found, a json string with `name` and `description` will be shown in the browser.
In case you want to use the "Docker" profile, make sure you have "Docker Desktop" installed, from the [docker website](https://www.docker.com/products/docker-desktop).
## Wanted improvements
* Add documentation, possibly with swagger
* Adding a validation service layer, so the incoming data can be validated before any other call
* Adding more test coverage for the services behind the controller