创建模式定义

模式为开发者提供有关在调用 API 操作时应发出的请求或者应接收的响应的信息。 您可以在 API 定义中的各种位置创建模式。

准备工作

注: 在将模式用于验证之前，将对其进行编译。 因为编译过程比验证过程更长，所以编译后的模式工件存储在高速缓存中。 高速缓存的容量有限，这会导致在添加新条目时从高速缓存中逐出旧条目。 如果模式的工件已经被逐出高速缓存，则必须重新编译模式，这可能会导致验证出现明显延迟。
有关 API 定义中可创建模式的区域的详细信息，请参阅以下主题：

关于此任务

注: 此任务与配置 OpenAPI 2.0 API 定义相关。 有关如何配置 OpenAPI 3.0 API 定义的详细信息，请参阅 编辑 OpenAPI 3.0 API 定义。

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

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

过程

  1. 要创建模式定义，请单击 "定义"旁边的添加图标 "OpenAPI 2.0应用程序接口添加图标。
    显示模式的添加对象向导。
  2. 提供以下信息：
    • 模式名称: 此名称定义了一个键，该键允许从 API 定义中的其他位置引用此模式; 该引用具有以下格式:
      #/definitions/Name
    • 标题: 模式标题。
    • 类型：模式数据类型；选择下列其中一项：
      • ARRAY
      • BOOLEAN
      • 整数
      • 数字
      • object
      • string
  3. 单击 创建。
    显示模式定义详细信息，以便进一步编辑；请参阅编辑模式定义。