laravel api

Серверный проект Laravel/PHP

Ссылка на живую производственную сборку

Добро пожаловать в еще один из моих проектов API. Для этого проекта я написал, протестировал и развернул приложение Laravel как часть полнофункционального проекта, воспользовавшись многими мощными функциями фреймворка, включая:

• фасады и вспомогательные функции;
• аутентификация и авторизация пользователя;
• заполнение базы данных;
• Eloquent построитель запросов ORM;
• расширенные инструменты тестирования API.

Для чего это нужно?

Этот API обрабатывает данные, связанные с пользователями/кандидатами и их экзаменами. Например, он позволяет пользователю просматривать информацию о местах/местах проведения экзаменов, датах, именах кандидатов и т. д.

Важное замечание о доступе

• Убедитесь, что вы включили HTTP-заголовок Accept: application/json во все запросы к API.
• Большинство функций API доступны только пользователям с правами администратора. Чтобы поэкспериментировать с этим приложением, вы можете зарегистрировать новую учетную запись, используя адрес электронной почты, заканчивающийся на @v3.admin , который предоставит вам полные права администратора.

 // To sign up as an admin, make a POST request to https://laravel-php-api.vercel.app/public/api/signup and include a request body in the following format:

        {
		    "name" : " Anna Torpid " ,
		    "email" : " [email protected] " ,
		    "password" : " dfbdf9suhfd9shf " ,
		    "password_confirmation" : " dfbdf9suhfd9shf "
        }

// To login, make a POST request to https://laravel-php-api.vercel.app/public/api/login and include a request body in the following format:

        {
		    "email" : " [email protected] " ,
		    "password" : " dfbdf9suhfd9shf "
        }

// The above POST request returns this response. Make sure to include the returned token in the authorisation header of all future requests.

        {
	        "user" : {
		        "id" : 11 ,
		        "name" : " Anna Torpid " ,
		        "email" : " [email protected] "
	        },
	        "token" : " 5|tAujbY9luWTKquNEruGHU7soCXp7MuzVb8WR0VO9 "
        }

После регистрации или входа в систему вам будет выдан токен API, который необходимо будет прикрепить к заголовкам ваших запросов, чтобы обеспечить полный доступ к CRUD.

Доступные конечные точки

Чтобы получить доступ к каждой конечной точке, добавьте фрагмент URI к корневой конечной точке. Более подробную информацию можно просмотреть, посетив корневую конечную точку.

Ресурс	Описание	Аутентификация/авторизация
Почта/подписка	Создать новую учетную запись.	Общественный
Почта/логин	Войдите в существующую учетную запись.	Общественный
ПОЛУЧИТЬ /выход/{идентификатор}	Выход из системы (отзыв токенов).	Только авторизованные пользователи
GET /экзамены	Показывает список всех экзаменов. Включает 5 дополнительных параметров запроса .	Только для администратора
ПОЛУЧИТЬ /экзамены/{id}	Сдайте специальный экзамен.	Можно видеть только свои экзамены
PUT /экзамены/{id}	Изменить конкретный экзамен.	Можно редактировать только свои экзамены
GET /exams/search/{имя}	Поиск подстроки для конкретного кандидата.	Только для администратора
УДАЛИТЬ /экзамены/{id}	Удалить экзамен.	Можно удалить только свой экзамен
ПОЛУЧИТЬ /пользователи	Получить список всех пользователей.	Только для администратора
ПОЛУЧИТЬ /users/{id}/exams	Получить список всех экзаменов пользователя	Можно видеть только свои экзамены

Ключевые особенности продукта

• Развернуто на Vercel как «бессерверная функция», использующая среду выполнения PHP для обработки конфигурации приложений.
• Производственное развертывание связано с действующей базой данных PSQL, удаленно размещенной у другого поставщика.
• Выразительный синтаксис, специфичный для Laravel, с обширной цепочкой методов, позволяющий создать более краткую структуру кода.
• Разработан методом тестирования с использованием PHPUnit и свободного синтаксиса JSON Laravel (на основе замыканий и класса AssertableJson).
• Автоматизированное тестирование с использованием рабочего процесса CI/CD, настроенного с помощью действий Github.
• Создан с использованием объектно-ориентированного шаблона MVC.
• Службы аутентификации, реализованные с использованием Sanctum
  • Пользователи могут зарегистрироваться и войти в систему.
  • Защищенные маршруты доступны только пользователям с действительными токенами API.
• Службы авторизации реализованы с использованием шлюзов Laravel — подхода к авторизации, основанного на закрытии.
  • Определенные действия разрешены только пользователям с определенными ролями, например со статусом администратора.
• Отношения и ограничения схемы, определенные с помощью инструментов отношений Eloquent ORM.
• База данных SQLite, используемая для разработки и тестирования.

Основные файлы и папки в каталоге проекта

• ./app содержит основную логику приложения.
  • /app/Http/Controllers содержит логику обработки запросов.
  • app/Models содержит все классы моделей и здесь мы указываем все заполняемые поля.
  • app/Providers содержит классы, которые загружают все приложение.
• ./routes/api.php — это место, где мы кратко определяем все наши маршруты (конечные точки).
• ./tests/Feature содержит все интеграционные тесты приложения.
• ./config/database.php позволяет вам настроить параметры подключения к базе данных.
• ./database — еще одна очень важная папка.
  • ./database/factories содержит фабричные классы, которые используются для заполнения баз данных.
  • ./database/migrations позволяет нам изменять нашу модель данных.
  • ./databse/seeders содержит классы, которые заполняют базу данных через фабрики.

Запуск проекта в вашей локальной среде

Сначала убедитесь, что на вашем компьютере установлены PHP и Composer.

Минимальные требования к версии: PHP ^8.1 ; Композитор 2.5.4 .

1. Форкните и клонируйте репозиторий.

2. перейдите в репозиторий и выполните следующие команды CLI:

    composer update
    composer install
   

3. Переименуйте файл .env.example в .env , удалите переменные для соединения MySQL по умолчанию и убедитесь, что вы добавили следующие 3 переменные:

    DB_CONNECTION=sqlite
    DB_FOREIGN_KEYS=true
    USE_SQLITE_SYNTAX=like
    DB_DATABASE= this needs to be the absolute path to the sqlite database located in ./database/database.sqlite, e.g. /home/username/mydocuments/laravel-api/database/database.sqlite*
   

4. Чтобы развернуть локальный сервер разработки, запустите команду Artisan CLI:

    php artisan serve
   

5. Чтобы запустить тестовый комплект, выполните команду Artisan CLI:

    php artisan test