API

System Requirements

• Docker
• Docker Compose

Install Guide

1. Clone the repository

git clone git@github.com:howToCodeWell/code-quiz.git

2. Spin up the containers

docker-compose up -d

3. Install database migrations

docker-compose exec api bin/console doctrine:migration:migrate

4. Load data fixtures

docker-compose exec api bin/console doctrine:fixtures:load

5. Add the following entry to the /etc/hosts

127.0.0.1 codequiz.local
127.0.0.1 api.codequiz.local

Make a HTTP request to the API

http://api.codequiz.local/api/v1

Generating the OpenAPI specification

From the api folder run the following to create openapi.yaml in the ./docs/generated folder. This is ignored from the code base

docker-compose exec api bash -c "bin/console api:openapi:export --yaml" > ./docs/generated/openapi.yaml