REST api, Laravel, used in Notes app.

API Documentation

1. Clone repo and install all dependencies:

composer install

Make sure you created .env

cp .env.example .env

with properties set with link to Notes application

SESSION_DOMAIN=
SANCTUM_STATEFUL_DOMAINS=

Dont forget to php artisan key:generate

2. Create database and set correspond properties in .env

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=notes
DB_USERNAME=
DB_PASSWORD=

3. Populate db with migrations and seeds:

php artisan migrate --seed

4. Generate OpenApi json file, required for Swagger documentation by custom command, php artisan openapi:generate, located in app/Console/Commands/GenerateOpenApiJson.php, which generates api.json in ./public/docs directory if you run it w/o arguments.

• First argument is a path and a name for the generated file (extension must be json) ./public/docs/api.json by default.
• Second argument is a directory to scan for OpenApi PHPDocs, app by default.

• Login and registration, logout
• Adding new, updating and deleting notes

• Laravel
• OpenApi/Swagger
• PHPFaker for seeds