API BileMo

Description

This project is the 7th project of the Developer PHP / Symfony formation of Openclassrooms.

The goal of this project to make an API that respect the level 3 of Richardson maturity model with cache management.

Concerning the authentication it's managed via JWT Token and Refresh Token

How it work

Build with

Server :

• PHP v7.4.19
• Apache v2.4.48

• MySQL v8.0.24
• Server : for the server you can turn to the classics: WAMP, MAMP, XAMPP ...Or test the best of the swiss knives server: Laragon, my favorite ❤️

Framework & Libraries :

• Symfony 5.3.9

• Composer
• FakerPHP/Faker v1.16.0
• liorchamla/faker-prices v2.0.0
• Friendofsymfony/Rest-bundle v3.1.0
• Jms/Serializer-bundle v3.15.0
• Babdev/Pagerfanta-bundle v3.3.0
• Lexik/Jwt-authentication-bundle v2.13.0
• Gesdinet/Jwt-refresh-token-bundle v1.0.0 beta4
• Willdurand/Hateoas-bundle v2.3.0
• Nelmio/Api-doc-bundle v4.6.2

Installation

Clone or download the repository, and put files into your environment,

https://github.com/leCheveuCodeur/API_BileMo.git

Install libraries with composer,

composer install

Configure your environment with .env file :

# DATABASE_URL="mysql://db_user:db_password@127.0.0.1:3306/db_name?serverVersion=8"


###> INIT CUSTOMER ###
CUSTOMER_COMPANY='your_company'
CUSTOMER_EMAIL='your_email_company@email.com'
CUSTOMER_PASSWORD='your_password'
###< INIT CUSTOMER ###

Initialise your Database :

1 - create your database :

php bin/console d:d:c

2 - create the structure in your database :

php bin/console d:m:m

3 - and install fixturesfor have first contents and your Admin account :

php bin/console d:f:l -n

Generate your SSL keys

php bin/console lexik:jwt:generate-keypair

And Voilà !

Access to API documentation

• Json documentation: /api/doc.json
• Html interactive documentation: /api/doc