openapi-generator.md

Генерація коду, через openapi-generator

В сервісі використовується бібліотека "rollun-com/rollun-openapi", що дозволяє генерувати код на основі спеціального документа - маніфесту. Детальніше про це можете почитати в репозиторії з бібліотекою.

Команди для генерації

• Щоб згенерувати код серверної частини необхідно запустити команду:

docker compose run --rm php-openapi-generator php vendor/bin/openapi-generator generate:server

для якої доступний аліас make openapi-generate-server

• Для клієнтської частини:

docker compose run --rm php-openapi-generator php vendor/bin/openapi-generator generate:client

та аліас make openapi-generate-client

Тестовий маніфест

Для тестів, в директорії manifests, доступний маніфест skeleton__v1, на якому ви можете поекспериментувати з генерацією коду.

Права на згенерованних файлах

Оскільки код генерується всередині docker контейнеру від імені користувача root, то можуть виникнути проблеми, з тим, що від свого користувача на хост машині ви не зможете видалити файли, які згенерувались. Щоб це виправити можна змінити права на файли за допомогою команди:

sudo chown -R {group}:{user} .

Де group, user - ваша група та користувач на хост машині.

Наприклад, якщо ваш користувач називається rollun, то команда буде виглядати наступним чином:

sudo chown -R rollun:rollun .