路径是可供调用的 REST API 单元。 路径由 HTTP 动词和 URL 路径构成。 通过配置路径,您可以定义向开发者公开 API 的方式。
关于此任务
您可以使用 API Designer UI 应用程序或使用基于浏览器的 API Manager UI 来完成此任务。
您可以随时通过单击 源 图标
直接切换到底层 OpenAPI YAML 源。 要返回到设计表单,请单击 表单 图标
。
过程
- 打开 API 以进行编辑,如 编辑 OpenAPI 2.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
- $ref (编辑现有路径时可用): 对此 OpenAPI 定义或外部文件中在其他位置定义的路径的引用。 对于该 API 中的路径,或者作为完整 API 定义或 OpenAPI 片段的某个文件中的路径,引用均可复用已为这些路径定义的一组操作。
该引用使用 JSON 指针表示法。 例如,对此 API 中名为
/mypath 的路径的引用将采用以下格式:
#/paths/~1mypath
~1
字符用于对
/ 字符进行转义,“/”在路径名中用作字面值,而不是特殊字符。
对名为
path_fragments.yaml 的外部文件中路径的引用将采用以下格式:
file://path_fragments.yaml/paths/~1mypath
- 如果要创建新路径,请单击 创建。
显示路径详细信息以进行进一步编辑,如步骤
4中所述。
- 完成后单击 保存 。