Это RESTful API для сервиса НашБилет, позволяющее регистрировать пользователей, управлять билетами и мероприятиями.
- Framework: Laravel 12
- Auth: Laravel Sanctum (Token-based)
- Documentation: L5-Swagger (OpenAPI 3.0)
- Database: MySQL / PostgreSQL
- Клонируйте репозиторий:
git clone [https://github.com/your-username/afisha-api.git](https://github.com/your-username/afisha-api.git) cd afisha-api - Установите зависимости:
composer install
- Настройка окружения:
cp .env.example .env php artisan key:generate
- Настройте базу данных в .env:
DB_CONNECTION=mysql DB_HOST=127.0.0.1 DB_PORT=3306 DB_DATABASE=afisha_db DB_USERNAME=root DB_PASSWORD=
- Запустите Миграции:
php artisan migrate
- Запустите сервер:
php artisan serve
В проекте настроен Swagger для удобного тестирования запросов.
- Сгенерируйте документацию:
php artisan l5-swagger:generate
- Откройте документацию в браузере:
http://127.0.0.1:8000/api/documentation
💡 Подсказка по работе со Swagger: > Если ты добавишь новые методы в контроллеры, не забудь запустить php artisan l5-swagger:generate, чтобы они появились в списке!
| Метод | Путь | Описание |
|---|---|---|
| POST | /api/login | Авторизация пользователя |
| POST | /api/register | Регистрация пользователя |
| POST | /api/logout | Выход из системы |
🔑 Как пользоваться авторизацией в Swagger:
- Войдите через
/registerи затем войдите через/api/login. - Скопируйте
tokenиз ответа. - Нажмите кнопку
"Authorize"вверху страницы Swagger. - Вставьте токен и нажмите кнопку подтверждения. Теперь вы можете тестировать защищенные методы.
app/
└── Http/
├── Controllers/
│ └── Auth/ # Регистрация и авторизация
├── Requests/ # Валидация входящих данных
routes/
└── api.php # Все API маршруты