通过导入 OpenAPI 定义文件来添加 REST API
您可以使用 OpenAPI 定义文件将 REST API 导入到 IBM® API Connect中。
准备工作
您的文件必须符合 OpenAPI 规范的 2.0 或 3.0 版本。 该文件的格式可以是 JSON 或 YAML。
注: 无法验证或发布包含具有 Swagger 属性 (使用 regex ) 的 API 的产品,这些 API 包含诸如 "
(?
" 之类的前瞻断言。 系统会返回错误消息。 例如: Product has not been published!
The multipart 'openapi' field contains an OpenAPI definition with validation errors.
definitions.properties.pattern Does not match format 'regex' (context: (root).definitions.properties.pattern, line: 0, col: 0)
400
关于此任务
您可以使用 API Designer UI 应用程序或使用基于浏览器的 API Manager UI 来完成此任务。
仅限 API 管理器 UI: 要完成此任务,必须为您分配具有 Api-Drafts:Edit
, Settings:View
和 App:View
许可权的角色。 缺省情况下,预先提供的开发者角色具有这些许可权;如果为您分配了定制角色,那么必须具有这些许可权。 有关更多信息,请参阅 创建定制角色。
如果您正在使用 API Designer UI ,并且想要使用从其他位置下载的 OpenAPI 定义文件 (例如,从外部 Web 站点下载) ,而不是使用 API Connect创建,请使用此处描述的导入机制,而不是将该文件复制到本地 API Designer 目录中; 导入操作将添加 API Designer所需的 API Connect 特定部分。
过程
要通过导入 OpenAPI 文件来添加 REST API ,请完成以下步骤:
结果
后续操作
通过将 API 包含在产品中,然后将该产品发布到目录中,应用程序开发人员就可以使用这些 API。 有关更多信息,请参阅 使用产品 和 使用目录。