使用命令行界面 (CLI) 来创建和验证 API 与产品定义
IBM® API Connect 的 Developer Toolkit 提供了命令行界面,可用于创建和发布 API 和产品定义,以及验证 YAML 或 JSON 定义。
以下主题阐述了如何使用命令行界面来创建 OpenAPI 定义文件、创建产品定义文件以及验证 YAML 或 JSON 定义。
- 创建 OpenAPI 定义文件
在 OpenAPI 定义文件中按 YAML 格式定义 API。您可以使用 create 命令创建缺省 OpenAPI 定义文件,并使用您选择的编辑器来修改此文件。 - 为 API 定义指定网关类型
API 定义必须指定 API 要使用的网关类型。 - 转换 API YAML 文件以使用 DataPower API Gateway
IBM API Connect 现在支持 DataPower® API Gateway。您可以选择在自己的 API YAML 文件中指定此网关类型。 - 在 API 定义中引用扩展
要在 API 定义 YAML(或 JSON)文件中引用 OpenAPI 扩展,请在 x-ibm-configuration 下添加 extensions 键。 - 使用 $ref 在 OpenAPI 文件中复用代码片段
如果使用 Developer Toolkit 命令行将 API 部署到 IBM API Connect 管理服务器,那么可在 OpenAPI YAML 和 JSON API 定义文件中使用 $ref 字段,引用在单独文件中定义的 OpenAPI 代码的片段。当 API Connect 处理源 API 定义文件时,$ref 字段会替换为目标文件的内容。 - 创建产品定义文件
通过创建产品定义文件来定义产品。 - 使用 x-ibm-languages 创建多语种 API 和产品文档
通过在 API 和产品 OpenAPI 定义中使用 x-ibm-languages 扩展,创建多语种 API 和产品文档。 - 使用 x-example 控制 Developer Portal 中显示的示例
OpenAPI 不支持在参数上使用 example 属性,仅支持在请求和响应对象及其属性上使用此类属性。为使 API 开发者能够控制门户网站中显示的示例,可以在 OpenAPI 参数中使用 x-example。 - 验证 API 或产品的 YAML 或 JSON 定义
您可以使用 IBM API Connect Developer Toolkit 来验证 YAML 或 JSON 定义,或者可以查找并使用描述有效 API 和产品的模式来验证自己的 API 和产品定义。 - 创建和使用 API 和产品定义模板
创建 API 和产品定义时,可以使用模板文件。模板文件是包含变量的 Handlebars 模板,变量格式为 {{variable-name}},创建 API 或产品定义时将变量替换为值。 - IBM API Connect 中的 OpenAPI 3.0 支持
从 V2018.4.1.4 开始,IBM API Connect 支持 OpenAPI 3.0 规范,但存在一些限制。
父主题: 开发 API 和应用程序
相关参考:
- 可从以下位置获取有关 IBM API Connect 的更多信息:
- Twitter:#APIConnect
- LinkedIn:API Connect 团队
- YouTube:IBM API Connect 播放列表
- 要获取社区支持,请访问:
