Student management API - PHP

This is a RESTful API providing generic management functionalities of university students:

• students
• annotations (usually managed by tutors)
• internships
  • eligibilities
  • occupational safety and health course attendances
  • evaluations
  • interruption reports
• educational activity attendances

The API is documented with OpenAPI specification (version 3.0) and can be accessed via Swagger UI interface at URL /docs.

---

Installation

# Dependencies
composer install

# Static files

#  - to use default URL http://localhost
php scripts/setup.php

#  - to use custom URL
# php scripts/setup.php --application_url=<APPLICATION_URL>

# Edit .env with internship evaluation item details...

# Configuration of OpenAPI schema
php artisan openapi:configure

# Database structure
php artisan migrate

# [OPTIONAL] Test data
php artisan db:seed

If test data are not used, below tables must be filled with below Artisan commands:

• countries
• locations
• sub_locations

php artisan country:add "United States of America" US
php artisan location:add "Location A"
php artisan sublocation:add "Sub-location A"

Uninstallation

# Dependencies
rm -rf vendor
rm -rf public/docs

# Static files
php scripts/setdown.php

Local deployment

php -S localhost:80 -t public public/router.php

# Or with Docker
docker build -t francescozanoni/students-api-php .
docker run -d -p 80:80 --name students-api-php -v ${PWD}:/var/www/html francescozanoni/students-api-php