定义 API 的路径

在线编辑

路径是可供调用的 REST API 单元。路径由 HTTP 动词和 URL 路径构成。通过配置路径，您可以定义向开发者公开 API 的方式。

关于本任务

注：

此任务与配置 OpenAPI 3.0 API 定义相关。有关如何配置 OpenAPI 2.0 API 定义的详细信息，请参阅编辑 OpenAPI 2.0 API 定义。
OpenAPI 3.0 API 仅支持 DataPower® API Gateway，而不支持 DataPower Gateway (v5 compatible)。
有关当前 OpenAPI 3.0 支持限制的详细信息，请参阅 IBM® API Connect 中的 OpenAPI 3.0 支持。

您可以使用 API Designer UI 应用程序或使用基于浏览器的 API Manager UI 来完成此任务。

路径将附加到服务器 URL 以构成完整的 URL。有关配置服务器的详细信息，请参阅 “为 API 定义服务器 ”。

您随时可以通过点击“源代码”图标 OpenAPI 源图标，直接切换到底层的 OpenAPI YAML源代码。要返回设计表单，请点击 “表单 ”图标表单图标。

过程

打开 API 以进行编辑，如编辑 OpenAPI 3.0 API 定义中所述。
如果已定义一个或多个路径，请展开路径。
要创建新的路径，请单击导航窗格中 “路径 ”旁边的添加图标。要编辑现有路径，请单击导航窗格中的路径。
提供以下信息：
- 路径：单个端点的相对路径。
  该路径将附加到基础路径上，以构建访问 API 的完整 URI。路径必须以/字符开头而不是结尾。路径末尾的参数可包含用于匹配一个或多个路径级别的限定符。
  如果仅指定参数的名称，那么将匹配该路径的一个级别。如果要允许路径的多个级别，那么可以使用下列其中一个限定符作为参数的前缀:
  - * 表示出现 0 次或更多次
  - + 表示出现 1 次或更多次
  只能在路径末尾使用 + 和 * 限定符。
  例如，路径:
```
/petstore/{type}/{*category}
```
  与以下路径匹配，其中仅匹配一个类型值，但匹配所有 (0 或更多) 类别:
```
/petstore/cats
/petstore/cats/supplies
/petstore/cats/supplies/health
/petstore/cats/supplies/health/medicines
/petstore/cats/supplies/health/medicines/a/b/c
```
- 引用（编辑现有路径时可用）：引用在其他位置（此 OpenAPI 定义中或外部文件中）定义的路径。对于该 API 中的路径，或者作为完整 API 定义或 OpenAPI 片段的某个文件中的路径，引用均可复用已为这些路径定义的一组操作。
  该引用使用 JSON 指针表示法。例如，对此 API 中名为 /mypath 的路径的引用将采用以下格式：
```
#/paths/~1mypath
```
  ~1 字符用于对 / 字符进行转义，“/”在路径名中用作字面值，而不是特殊字符。
  对名为 path_fragments.yaml 的外部文件中路径的引用将采用以下格式：
```
file://path_fragments.yaml/paths/~1mypath
```
- 摘要：可选摘要，将应用于此路径中的所有操作。
- 描述：可选描述，将应用于此路径中的所有操作。您可以使用 CommonMark 语法来呈现富文本。
如果要创建新路径，请单击创建。
显示路径详细信息以进行进一步编辑，如步骤 4中所述。
完成后单击保存。