php-gear/auto-client

一个命令行工具,用于从REST PHP API生成JavaScript客户端API

1.0.6 2018-09-07 15:20 UTC

This package is auto-updated.

Last update: 2024-09-12 23:46:43 UTC


README

一个命令行工具,用于从REST PHP API生成JavaScript客户端API

介绍

此包提供了一个命令行工具,可用于Laravel框架(作为Artisan命令)或Electro框架(作为Workman命令)。

待办事项:提供有关此库的原理和一些使用示例的解释。

注意:目前,此工具生成用于AngularJS 1.x的代码,并期望有一个名为remote的Angular服务,类型为RemoteService

此要求是临时的,将在此工具的后续版本中删除。

文档

一旦找到时间,将编写额外的文档。

安装

运行时要求

  • PHP >= 7.0
  • AngularJS 1.x
可选之一
  • Laravel >= 4.2
  • Electro >= 1.0

在Laravel上安装

在命令行中输入

composer require php-gear/auto-client

artisan.php中注册Artisan命令

Artisan::resolve (PhpGear\AutoClient\Laravel\AutoClientCommand::class);

在Electro上安装

workman install php-gear/auto-client

用法

在Laravel上

配置

config/app.php中,定义要导出到JavaScript的API。

示例

return [
  'autoclient' => [
    'APIs' => [
      // Endpoint URL => [controller class, target directory, Angular module name] 
      'API/something' => [SomethingController::class, 'App/remote', 'App'],
    ],
  ],
  ///... the rest of the existing file
];

运行生成器

artisan autoclient:generate

在Electro上

运行生成器

workman autoclient:generate

许可证

此库是开源软件,根据MIT许可证许可。

请参阅随附的LICENSE文件。

版权© 2018 Cláudio Silva