SquadMakers Reto PHP - Jokes and Math API

This API provides a set of endpoints for jokes and math calculations.

ENDPOINTS

Joke

This endpoint provides jokes from different sources.

• saved in postgres database
• from https://icanhazdadjoke.com/
• from https://api.chucknorris.io

Get all jokes saved in DB

GET /jokes

#### Create a joke and save it to DB
```bash
POST /jokes

Get joke by number saved in DB

GET /jokes/{number}

Get a random joke

Returns a random joke from one of the following sources:

• https://icanhazdadjoke.com/
• https://api.chucknorris.io

GET /jokes/random

Get a joke by type

Returns a joke from one of the following sources, based on the parameter type:
If the parameter type is "dad" will return a joke from this source:

• https://icanhazdadjoke.com/
  If the parameter type is "chuck" will return a joke from this source:
• https://api.chucknorris.io
  If the parameter type is not "chuck" or "dad" will return an error

GET /jokes/by-type/{type}

Update a joke

PUT /jokes/{number}

Delete a joke

DELETE /jokes/{number}

Math

This endpoint provides two mathematical endpoint to calculate the least common multiple of a list of numbers and an increment endpoint that will return the incremented number passed by query parameters .

GET /math/least-common-multiple?numbers=12&numbers=2&numbers=34&numbers=45

GET /math/increment?number=12

Pre-reqs

To build and run this app locally you will need a few things:

• Install Php7.3
• Install Composer
• Install Docker
• Install Symfony-CLI
• Install for testing ANT

This api use mysql from Docker and is ready for use without any additional configuration.

Getting started

• Clone the repository

git clone --depth=1 https://github.com/Microsoft/TypeScript-Node-Starter.git <project_name>

• Install dependencies

cd <project-name>
composer install
docker run -d --rm --name mysql-api-rest-php -e MYSQL_ROOT_PASSWORD=root -p 3306:3306 -v mariadb_data:/var/lib/mysql mariadb

• Configure Data base
  Update database config on .env file. Check docker container ip.

bin/console doctrine:database:create
bin/console doctrine:schema:create

• Run the project

symfony server:start

This command will start the project Finally, navigate to http://localhost:8001 and you should see the project being served and rendered locally!

Testing

To run the tests, run the following command:

ant

This will delete database data, will load fixtures data, run the test and will check some other things like code style and code quality.

Another way to run the tests

bin/console doctrine:fixtures:load --env=test
bin/phpunit tests