README

仓库于 2019-12-31 废弃

此仓库已迁移至 laminas-api-tools/api-tools-admin-ui。

这是新 Apigility Admin 用户界面的源代码。我们从头开始使用 AngularJS 重写了 UI，提高了性能和可用性。

我们添加了一些新功能

• 支持连接数据库的 REST 服务；
• 自动发现数据库表和字段；
• 构建 API 文件包，准备部署（开发中，见 待办事项列表）；
• 按 API 认证（开发中，见 待办事项列表）；

注意

要运行新 UI，您需要使用 zf-apigility-skeleton 的 develop 分支。例如，您可以使用 composer 安装 develop 分支。

composer create-project zfcampus/zf-apigility-skeleton apigility dev-develop

此命令将在 apigility 本地文件夹中安装 zf-apigility-skeleton 应用程序。

要求

• npm，用于安装各种开发要求，主要包括 Grunt 和 Bower，并利用这些工具。
• Grunt 必须全局安装，以便可以使用它提供源构建和运行测试。
• Bower 必须全局安装，以便可以使用它安装开发依赖。

从该目录运行以下命令以安装依赖项

$ npm install

如果您尚未安装 Grunt，请安装它

$ sudo npm install -g grunt

如果您尚未安装 Bower，请安装它

$ sudo npm install -g bower

最后，使用 Bower 安装相关的 CSS 和 JS 库

$ bower install

调用 Admin

调用 Admin UI 有三种方式：作为 Apigility 项目的部分，通过 node 独立运行，或使用 Grunt 通过源代码。

通过 Apigility

将 admin 添加为项目的开发要求

$ composer require-dev "zfcampus/zf-apigility-admin-ui:~1.0"

并将模块 ZF\Apigility\Admin\Ui 添加到 config/development.config.php.dist（以及可能已处于开发模式的 config/development.config.php）中的模块列表中。

在您的 Apigility 应用程序中导航到 URI /apigility/ui 现在将触发 UI。

独立

独立方法使用node启动一个web服务器。此方法要求您有一个正在运行的Apigility Admin API，并且知道URL，以及该服务器配置为启用CORS；如果您需要帮助设置此方面，请参阅Apigility CORS文档。记下您的服务器URI；API URI将是<server>/apigility/api。

此外，我们建议记下您API文档的URI，以便导航项可以指向它。

使用以下命令启动管理UI：

$ node index.js --src --api=<URI to Apigility Admin API (ends in /apigility/api)>

（有关选项的帮助，请参阅node index.js -h。）

默认情况下，如果您没有指定端口号，服务器将在端口3000上运行；您可以使用--port=<port>选项指定端口号。

通过Grunt调用源

grunt serve命令执行多个操作

• 运行grunt watch，该命令寻找文件更改并运行诸如jshint、单元测试以及将部分合并到JS模板等任务。
• 运行一个livereload静态HTTP服务器；任何文件更改都会强制它重新加载，并触发加载了UI的任何浏览器窗口重新加载。

Grunt服务器与独立服务器以相同的方式运行：它接受相同的选项，并且具有相同的CORS限制。例如

$ grunt serve --api=<URI to Apigility Admin API (ends in /apigility/api)> \
> --doc=<URI to API documentation> --port=3001 --host=ag.dev

请参阅我们的贡献指南，了解如何运行测试和对UI进行黑客攻击。