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

路线经理

核心团队开发了路线管理器应用程序,通过 Route API 提供管理路线的用户界面。

这是一个可选应用程序,可在[应用程序集线器](https://apps.dhis2.org/app/5dbe9ab8-46bd-411e-b22f-905f08a81d78), and can be downloaded there or installed on an instance through the App Management app

路由列表](./resources/route-manager-list.png)

应用程序功能{ #app-functionality }

该应用程序为路由应用程序接口提供用户界面。在某些时候,应用程序接口可能会领先于应用程序,这是不可避免的,但应用程序正在持续发布中,并将尽快赶上应用程序接口。对于这些用例,您可以直接使用应用程序接口(或在 GitHub 上为应用程序贡献力量--我们欢迎贡献!)。

以下是该程序支持的功能概览。

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

通过应用程序,您可以进入_创建新路线_页面(主屏幕右上方的按钮)创建新路线。

创建路由](./resources/route-manager-create-route.png)

该页面允许您定义路由的不同属性。更多详情请查看上面的路由 API 文档。

除基本路由参数外,您还可以设置不同的身份验证方案,限制可以运行路由的授权,并为路由定义静态标头。

管理路由授权方案](./resources/route-manager-auth-schemes.png)

管理路由权限](./resources/route-manager-authorities.png)

就其提供的功能而言,应用程序接口有时领先于应用程序,即它支持更多的身份验证方案,但应用程序仍在不断更新,以赶上应用程序接口。

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

在应用程序主页的路线列表中,用户可以执行多项维护任务,如编辑路线、删除路线、禁用路线或共享路线。

使用每行上的切换按钮可以启用或禁用路线。

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

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

管理路由](./resources/route-manager-list-manage-options.png)

测试路线{ #testing-routes }

单击路由列表(Routes List)中的_Test route_(测试路由)按钮,即可测试路由。这将打开一个界面,你可以在此使用路由调用上游服务器。它允许你传递查询参数、请求正文(用于非 GET 请求)或上游服务器路径的其余部分(用于通配符路由)。

测试路由](./resources/route-manager-test-route.png)

点击 Test Route(测试路由)后,上游端点将被调用并显示结果。

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

从路由列表的扩展选项(三个点)中,可以打开共享对话框,该对话框可以限制特定用户或用户组的访问权限。

路由共享](./resources/route-manager-sharing.png)

如何获取路线管理器应用程序{ #how-to-get-the-route-manager-app }

该应用程序未与 DHIS2 捆绑,但可安装在 App Hub 应用程序下的应用程序管理应用程序中。

您还可以在 https://route-manager.netlify.dhis2.org/ 下查看和测试应用程序,例如将其指向 https://debug.dhis2.org/ 上的某个开发服务器。