API проекта "AlefTest"

Данный проект представляет собой API для управления студентами, аудиториями и лекциями. API написан на PHP с использованием фреймворка Laravel.

Инструкции по использованию

Установка

1. Клонируйте репозиторий:

   git clone https://github.com/ProgerAN/education-api-alefapp.git

2. Установите зависимости:

   composer install

3. Скопируйте файл .env.example в файл .env и настройте подключение к базе данных и другие настройки:

   cp .env.example .env

4. Создайте ключ приложения:

   php artisan key:generate

5. Выполните миграции для создания таблиц в базе данных:

   php artisan migrate

6. Запустите локальный сервер:

   php artisan serve

Использование API

API предоставляет следующие ресурсы:

• /api/students - студенты
• /api/classrooms - аудитории
• /api/lectures - лекции

Для каждого ресурса доступны методы:

• GET для получения данных
• POST для создания новых записей
• PUT для обновления записей
• DELETE для удаления записей

Примеры использования API с помощью Postman:

1. Получение списка всех студентов:

   GET http://localhost:8000/api/students
   

2. Создание новой лекции:

   POST http://localhost:8000/api/lectures
   Content-Type: application/json
   
   [
       {
           "id": 1,
           "topic": "Название лекции",
           "description": "Описание лекции"
       }
   
       ...
   ]
   

Тестирование

Для тестирования API вы можете использовать Postman. Экспортируйте коллекцию запросов из файла API Example.postman_collection.json и импортируйте ее в Postman. Пример запросов к API также доступен в этой коллекции.

Лицензия

Этот проект лицензирован по лицензии MIT.