Skip to content

xvj00/-

Repository files navigation

🎬 НашБилет API Backend

Laravel PHP Swagger

Это RESTful API для сервиса НашБилет, позволяющее регистрировать пользователей, управлять билетами и мероприятиями.


🛠 Технологии

  • Framework: Laravel 12
  • Auth: Laravel Sanctum (Token-based)
  • Documentation: L5-Swagger (OpenAPI 3.0)
  • Database: MySQL / PostgreSQL

🚀 Установка

  1. Клонируйте репозиторий:
    git clone [https://github.com/your-username/afisha-api.git](https://github.com/your-username/afisha-api.git)
    cd afisha-api
  2. Установите зависимости:
    composer install
  3. Настройка окружения:
    cp .env.example .env
    php artisan key:generate
  4. Настройте базу данных в .env:
     DB_CONNECTION=mysql
     DB_HOST=127.0.0.1
     DB_PORT=3306
     DB_DATABASE=afisha_db
     DB_USERNAME=root
     DB_PASSWORD=
  5. Запустите Миграции:
    php artisan migrate
  6. Запустите сервер:
    php artisan serve

📚 Документация

В проекте настроен Swagger для удобного тестирования запросов.

  1. Сгенерируйте документацию:
    php artisan l5-swagger:generate
  2. Откройте документацию в браузере:
    http://127.0.0.1:8000/api/documentation

💡 Подсказка по работе со Swagger: > Если ты добавишь новые методы в контроллеры, не забудь запустить php artisan l5-swagger:generate, чтобы они появились в списке!


🔒 Основные маршруты (Endpoints)

Метод Путь Описание
POST /api/login Авторизация пользователя
POST /api/register Регистрация пользователя
POST /api/logout Выход из системы

🔑 Как пользоваться авторизацией в Swagger:

  1. Войдите через /register и затем войдите через /api/login.
  2. Скопируйте token из ответа.
  3. Нажмите кнопку "Authorize" вверху страницы Swagger.
  4. Вставьте токен и нажмите кнопку подтверждения. Теперь вы можете тестировать защищенные методы.

🗂️ Структура проекта

app/
 └── Http/
     ├── Controllers/
     │    └── Auth/        # Регистрация и авторизация
     ├── Requests/         # Валидация входящих данных

routes/
 └── api.php               # Все API маршруты

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages