greensight / laravel-openapi-client-generator
Installs: 2 810
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 2
Forks: 3
Open Issues: 0
Requires
- php: ^7.2 || ^8.0
- ext-json: *
- nette/php-generator: ^3.5
Requires (Dev)
- laravel/framework: ^7.30 || ^8.40
- orchestra/testbench: ^5.3
- phpunit/phpunit: ^9.2
README
Deprecated, use https://github.com/ensi-platform/laravel-openapi-client-generator instead
Пакет для Laravel, который генерирует http клиенты к сервису при помощи OpenApi Generator. На данный момент есть поддержка для двух платформ: PHP и NodeJS.
Зависимости:
- Java 8 и выше.
- npm 5.2 и выше.
Установка:
composer require --dev greensight/laravel-openapi-client-generator
php artisan vendor:publish --provider="Greensight\LaravelOpenapiClientGenerator\OpenapiClientGeneratorServiceProvider"
- копирует конфиг генератора в конфиги приложения- измените, если требуется, настройки по умолчанию в конфигурационном файле
Запуск:
-
Перед запуском убедиться, что структура описания апи соответствует этим требованиям.
-
Настроить параметры генерации для соответствующих платформ (если дефолтные не подходят).
-
Генерация клиента:
-
После успешной генерации по пути
<output_dir_template>-js|php
для nodejs и php соответственно появится код клиента, который можно запушить в git, в корне будет лежать скрипт git_push который удобно использовать для этого. Соответствующие репозитории должны быть уже созданы в соответствующей системе контроля версий. Полное название репозитория формируется так:<git_user>/<git_repo_template>-js|php
для nodejs и php соответственно.
Ограничения
Пакет на данный момент не поддерживает генерацию в Windows окружении.