首页 > 解决方案 > Azure API 管理 - 开发门户:在操作视图上显示产品级别策略?

问题描述

我们最近启动了一个项目,通过 Azure 的 API 管理门户 (AAPIM) 运行一组 REST API,然后将它们路由到我们的后端系统。

我们有一些适用于所有操作(基本上是安全标头)的策略,因此我们没有将它们应用于每个操作,而是在产品级别应用它们,这在逻辑上是有意义的,并且在 AAPIM 处理 REST 请求时似乎有效。

但是,问题是产品级别的策略没有被拉到操作页面上,因此它并没有真正向开发人员展示操作的全部要求。这也意味着“试试看”不包括标题,因此开发人员需要手动添加它们(这显然不理想)。

我的期望是,这些策略会像处理请求时那样在 Developer Portal 上逐级向下传递?我已经阅读了有关更新页面模板和可用数据但无济于事的 Developer Portal 文档。例如,产品对象似乎没有操作用来输出策略的相关属性。想想看,像这样在产品级别设置的策略不会显示在开发人员门户的任何地方。在“所有 API”级别应用时也会发生同样的情况。

我错过了什么或者这不可能吗?

标签: azuredocumentation-generationazure-api-management

解决方案


在 APIM 中,策略被认为是 API 实现细节的一部分,因此不会以任何方式影响 API 在 Dev Portal 中的呈现方式。对 Dev Portal 来说唯一重要的是 API/操作规范。目前没有办法在 API 级别为操作声明公共标头,唯一支持的方式是在操作规范中。因此,您必须将该信息添加到每个操作中。如果其中有很多人使用 Azure 门户中的开放 API 规范视图可能会有所帮助,因为它允许您作为一个整体编辑 API,并且您可以在那里复制内容。或者您可以通过 API 将其自动化。


推荐阅读