Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Vahagn-99/stock_api

Repository files navigation

📦 Stock API

REST API приложение для справочника Организаций, Зданий и Деятельности.

Инструкция

1. Клонирование репозитория

1. git clone https://github.com/Vahagn-99/stock_api.git stock_api

2. cd stock_api

2. Настройка переменных окружения

Скопируйте .env.example в .env и задайте параметры:

cp .env.example .env

3. Запуск контейнеров

docker-compose up -d --build

4. Установка зависимостей, миграции и сидеры

1. docker exec -it stock.app /bin/zsh

2. composer install

3. php artisan migrate --seed

5. Генерация API токена

php artisan new:access_token

🔐 Авторизация

Все запросы к API требуют заголовок:

Authorization: Api-Key {ваш_токен}

🧪 Swagger UI

Документация доступна по адресу:

http://localhost/api/documentation

📚 Основной функционал

  • Получение организаций по зданию или деятельности
  • Геопоиск организаций
  • Поиск по названию и виду деятельности (с учетом вложенности)
  • Список всех зданий
  • Просмотр организации по ID

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages