rnd-cosoft/api-tools-admin-ui

Laminas API Tools Admin UI 模块

2.2.1 2024-05-10 08:07 UTC

README

Build Status

🇷🇺 致俄罗斯公民

我们是来自不同国家的 Laminas 参与者。我们中许多人有在俄罗斯和乌克兰的朋友、亲戚和同事。我们中的一些人出生在俄罗斯。我们中的一些人目前居住在俄罗斯。我们中的一些人的祖父母曾在二战中与法西斯作战。这里没有人支持法西斯主义。

我们中的一位成员有一位乌克兰亲戚和她儿子一起逃离了家园。由于前方道路被轰炸,火车延误了。我们有一些朋友躲在防空洞里。我们在空袭后焦虑地追踪他们的消息,空袭无差别地袭击医院、学校、幼儿园和房屋。我们不是从任何媒体上得知这些,这是我们的亲身经历。

您对我们足够信任,使用我们的程序,我们请求您再次信任我们。我们需要帮助。走出家门,抗议这场毫无意义的战争。停止流血。说“停止战争!”

🇺🇸 致俄罗斯公民

我们在 Laminas 来自世界各地。我们中许多人有在俄罗斯和乌克兰的朋友、家人和同事。我们中的一些人出生在俄罗斯。我们中的一些人目前居住在俄罗斯。我们中的一些人的祖父母曾在二战中与纳粹作战。这里没有人支持法西斯主义。

我们的一位团队成员有一位乌克兰亲戚和她儿子一起逃离了家园。由于前方道路被轰炸,火车延误了。我们有一些朋友躲在防空洞里。我们在空袭后焦虑地追踪他们的消息,空袭无差别地袭击医院、学校、幼儿园和房屋。我们不是从任何媒体上得知这些,这是我们的亲身经历。

您对我们足够信任,使用我们的软件。我们要求您信任我们,说出真相。我们需要您的帮助。走出家门,抗议这场无谓的战争。停止杀戮。说“停止战争!”

这是 Laminas API Tools Admin 用户界面的源代码。我们从零开始重新编写了 UI,使用 AngularJS,提高了性能和可用性。

我们添加了一些新功能

  • 支持 Doctrine 的 DB 连接 REST 服务;
  • DB 自动发现表和字段;
  • 按 API 身份验证(开发中,请参阅 待办事项列表);

注意

要运行新的 UI,您需要使用 api-tools-skeletondevelop 分支。例如,您可以使用 composer 安装 develop 分支。

composer create-project laminas-api-tools/api-tools-skeleton api-tools dev-develop

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

要求

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

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

$ npm install

如果您尚未安装Grunt,请先安装它

$ sudo npm install -g grunt

如果您尚未安装Bower,请先安装它

$ sudo npm install -g bower

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

$ bower install

调用管理员

有三种方式可以调用管理员UI:作为Laminas API Tools项目的一部分,通过node独立运行,或者通过源使用Grunt。

通过Laminas API Tools

将管理员添加到项目的开发需求中

$ composer require-dev "laminas-api-tools/api-tools-admin-ui:~1.0"

并将模块Laminas\ApiTools\Admin\Ui添加到config/development.config.php.dist中的模块列表(如果已经在开发模式中,可能还需要添加到config/development.config.php中)。

在您的Laminas API Tools应用程序中导航到URI /api-tools/ui 将现在触发UI。

独立运行

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

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

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

$ node index.js --src --api=<URI to Laminas API Tools Admin API (ends in /api-tools/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 Laminas API Tools Admin API (ends in /api-tools/api)> \
> --doc=<URI to API documentation> --port=3001 --host=ag.dev

请参阅我们的贡献指南,了解如何运行测试和对UI进行修改。