ensi/laravel-openapi-client-generator

0.13.4 2023-11-15 06:30 UTC

Requires

• php: ^8.1
• ext-json: *
• nette/php-generator: ^3.5

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.14
• laravel/framework: ^8.40 || ^9.0 || ^10.0
• orchestra/testbench: ^6.0 || ^7.0 || ^8.0
• pestphp/pest: ^1.22 || ^2.0

MIT

• Ilya Nekrasov

README

Пакет для Laravel, который генерирует http клиенты к сервису при помощи OpenApi Generator. На данный момент есть поддержка для одной платформы: PHP.

Зависимости:

1. Java 8 и выше.
2. npm 5.2 и выше.

Установка:

1. composer require --dev ensi/laravel-openapi-client-generator
2. php artisan vendor:publish --provider="Greensight\LaravelOpenapiClientGenerator\OpenapiClientGeneratorServiceProvider" - копирует конфиг генератора в конфиги приложения
3. измените, если требуется, настройки по умолчанию в конфигурационном файле

Запуск:

1. Перед запуском убедиться, что структура описания апи соответствует этим требованиям.

2. Настроить параметры генерации (если дефолтные не подходят).

3. Генерация клиента:

   • php

4. После успешной генерации по пути <output_dir_template>-php появится код клиента, который можно запушить в git, в корне будет лежать скрипт git_push который удобно использовать для этого. Соответствующие репозитории должны быть уже созданы в соответствующей системе контроля версий. Полное название репозитория формируется так: <git_user>/<git_repo_template>-php.

Ограничения

Пакет на данный момент не поддерживает генерацию в Windows окружении.