创建 API 和应用程序

在线编辑

您可以使用 开发者工具箱来开发 API 代理和 API 实现。 在本文档中，API 引用了 API 代理，应用程序则引用了 API 实施。

您可以使用开发者工具包 ，通过调用 ` OpenAPI ` 来代理现有后端实现，从而创建与语言无关的 API；或者用于增强使用其他语言或框架（如 Express®、Java™、 Swift、Go 等）开发的应用程序。

创建开发工件定义

通过以下命令，使用 apic create 命令来创建开发工件：

表 1. 参考信息
命令 描述
apic create:api 创建 OpenAPI 定义。
apic create:api --wsdl filename 通过 WSDL 定义文件或通过包含服务 WSDL 定义文件的 .zip 文件来创建 SOAP API 定义。 生成的 API 的名称和版本可从 WSDL 文件获取。

如果上载 .zip 文件，那么可以在 .zip 文件中包含选项文件以指定其他伪指令。 有关详细信息，请参阅 “导入 WSDL 服务时使用选项文件 ”。
apic create:product 创建 API 产品定义。
注: 您可以使用 --template template-name 选项从 OpenAPI 模板文件创建 API 或产品。

您也可以通过提供 --title 选项，以非交互方式创建产品和 API 定义。 该选项会设置某些值，您也可以使用其他选项来定制，例如：

apic create:api --title Routes
apic create:product --title "Climb On"

您还可以同时创建 API 和产品定义：

apic create:api --title Routes --product "Climb On"
apic create:api --wsdl globalweather.wsdl --product "Weather Forecasting"

或者，您可以在创建新产品时创建 API，然后对其进行引用，例如：

apic create:api --title Routes
apic create:api --title Ascents
apic create:product --title "Climb On" --apis "routes.yaml ascents.yaml"

验证开发工件定义

在编辑开发工件之后或者在发布工件之前，最佳实践是对其进行验证，例如：

apic validate routes.yaml                      # Validate an API
apic validate climb-on.yaml                    # Validate the Product and its APIs
apic validate climb-on.yaml --product-only     # Validate the Product only (do not validate the referenced APIs)
注: 如果定义 API 的 OpenAPI 文件使用 $ref 字段来引用在单独文件中定义的 OpenAPI 代码片段，在使用 apic drafts:validate 命令创建草稿 API 之前， $ref 字段将替换为目标文件的内容。 有关更多信息，请参阅 使用 $ref 在 OpenAPI 文件中复用代码片段。