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

Требования:

Docker(сделал через Laravel Sail)

Установка:

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

Скопируйте .env.example в .env

Запустите Docker контейнеры(alias sail='sh $([ -f sail ] && echo sail || echo vendor/bin/sail)'
, после sail up)

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

sail composer install

Запустите миграции и сиды:

sail artisan migrate --seed

API Endpoints:

Организации

GET /api/organizations/by-building/{building} - список организаций в здании
GET /api/organizations/by-activity/{activity} - список организаций по виду деятельности
GET /api/organizations/by-location - список организаций в заданном радиусе/области
GET /api/organizations/{organization} - информация об организации
GET /api/organizations/search - поиск организаций

Параметры поиска по локации
jsonCopy{
	"latitude": float,
	"longitude": float,
	"radius": float (в километрах)
}

или

jsonCopy{
	"bounds": {
		"sw_lat": float,
		"sw_lng": float,
		"ne_lat": float,
		"ne_lng": float
	}
}

Swagger Documentation:

sail artisan l5-swagger:generate

Swagger UI доступен по адресу: http://localhost/api/documentation

API-KEY:

header: X-API-Key

key: 88005553535

PS. для удобства тестинга прописал его так же в экзампл файле)