diff --git a/README.md b/README.md index b0582c1795170dae262844b80e100c6072b1d364..cb2e5cc3d0252f6019019a4e1bf93d4ba6bfe332 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,16 @@ To login to Adminer in your browser you need to specify: * Password: same as `DB_PASSWORD` in your .env file * Database: same as `DB_NAME` in your .env file + +## REST API + +| requirement |endpoint | method | criteria | +| ------------- | ------------- | ------------- | ------------- | +| Search for a movie | /search | get | returns array of movies as a result of search +| Show a single movie | /movie/:id | get | return movie +| Show popular movies | /movie/preview | get | returns array of few movies (popular) to preview +| Show a single director | /director/:id | get | returns array of few movies (popular) to preview + ## TODO More TBA as features are implemented.