Skip to main content

根据 OpenAPI 规范生成客户端

如何使用 repo-tools schema openapi generate-client 生成客户端？​

先决条件​

  1. 将 OpenAPI 文件的info.title设置为您的插件 ID、
info:
  # your pluginId
  title: catalog

目前，我们不支持生成全新插件，而只支持生成客户端文件。

生成您的客户​

  1. 运行 yarn backstage-repo-tools schema openapi generate-client --input-spec <file> --output-directory <directory>. 这将在 <directory>/src/generated 中创建一个新文件夹，用于存放生成的内容。 2. 您应按如下方式使用生成的文件、
  • apis/DefaultApi.client.ts - 这是您应该使用的客户端。 它为您的 API 上的所有各种操作提供了类型。 models/* - 这些是从您的 OpenAPI 文件中生成的类型，理想情况下，您应该不需要直接使用这些类型，而可以使用从 apis/DefaultApi.client.ts 中推断出的类型。 models/* - 这是您的 OpenAPI 文件中生成的类型，理想情况下，您应该不需要直接使用这些类型，而可以使用从 apis/DefaultApi.client.ts 中推断出的类型。