跳转至
For the complete DHIS2 documentation index, see llms.txt.

路线经理

核心团队开发了“路线管理器”(Route Manager)应用,旨在提供一个用户界面,用于通过 路线 API 管理路线。

这是一款可选应用,可在 App Hub, and can be downloaded there or installed on an instance through the App Management app 上获取。

路线列表

应用功能{ #app-functionality }

该应用为 Route API 提供了一个用户界面。在某些情况下,API 难免会领先于应用,但该应用采用持续发布模式,将尽快与 API 保持同步。对于此类使用场景,您可以随时直接使用 API(或在 GitHub 上为该应用贡献代码——我们欢迎您的贡献!)。

以下是该应用所支持功能的概述。

创建新路线{ #creating-new-routes }

通过该应用,您可以进入_创建新路线_页面(主屏幕右上角的按钮)来创建一条新路线。

创建路由

在此页面上,您可以定义路由的各项属性。更多详细信息,请参阅上方的路由 API 文档。

除了基本的路由参数外,您还可以配置不同的身份验证方案、限制可以运行该路由的授权实体,并为该路由定义静态头信息。

管理路由授权方案

管理路由权限

就提供的功能而言,API 有时比应用程序更先进,例如它支持更多的身份验证方案,但应用程序也在不断更新,以跟上 API 的步伐。

编辑、删除和停用现有路线{ #editing-deleting-and-disabling-existing-routes }

在应用主页的路线列表中,用户可以执行多项维护操作,例如编辑路线、删除路线、禁用路线或分享路线。

可以通过每行上的切换按钮启用或禁用一条路由。

要编辑路线,请点击小铅笔图标。这将带您进入一个与“创建”页面类似的页面,您可以在该页面上编辑路线。

点击路线表右侧栏中的三个点图标,可查看该路线的其他选项、将其删除或编辑其共享设置。

管理路由

测试路线{ #testing-routes }

您可以通过点击“路由列表”中的“测试路由”按钮来测试一条路由。这将打开一个界面,您可以在其中使用该路由调用上游服务器。 该功能允许您传递查询参数、请求正文(针对非 GET 请求)或上游服务器的路径剩余部分(适用于通配符路由)。

测试路由

点击“测试路由”后,将调用上游端点并显示结果。

配置路由元数据共享{ #configuring-the-route-metadata-sharing }

在“路线”列表的扩展选项(三个点)中,您可以打开“共享”对话框,该对话框允许您将访问权限限制为特定用户或用户组。

路由共享

如何获取“Route Manager”应用{ #how-to-get-the-route-manager-app }

该应用未随DHIS2捆绑提供,但可在“应用管理”应用的 应用中心 中的“应用管理”应用内进行安装。

您还可以通过以下链接查看并测试该应用:https://route-manager.netlify.dhis2.org/,并将其指向例如位于 https://debug.dhis2.org/ 上的其中一台开发服务器。