跳到主要内容

生成服务器代码

通过服务器代码生成，你可以根据 OpenAPI 3 规范生成服务器端样板代码。这使你能够根据 API 规范运行服务器，并将其用作开发业务逻辑的起点。

支持的语言和框架包括：

  • Go -Chi 服务器
  • NodeJS-快递
  • Java -JAX-RS
  • Python-烧瓶

生成服务器代码​

要从你的 OpenAPI 3.0 定义生成服务器端样板，请执行以下操作：

  1. 在边栏中选择API，然后选择具有 OpenAPI 3.0 定义的 API。

  2. 在右侧边栏中，选择代码生成图标 代码片段图标 。

    编辑接口

  3. 在代码生成窗格中，为样板代码选择语言和框架。

  4. （可选）选择仅生成路由和接口以减少生成的文件数量。了解有关 仅生成路由和接口的 更多信息。

  5. 选择生成代码。

生成的代码会自动下载为 ZIP 存档。文件名包括 API 的名称以及所选的语言和框架。

使用生成的代码​

生成的代码结构取决于你选择的语言。每种受支持的语言都涵盖了 OpenAPI 3.0 规范中的一些主要功能。以下是你可以从生成的代码中获得的一些功能：

  • 所有操作都作为服务器样板中的路由生成，每个端点都有一段存根代码，你可以在其中添加业务逻辑。此存根可能包含从关联端点的 API 定义响应部分获取的默认响应。
  • 你可以在适用时访问每个路由中的请求主体、参数、路径参数和 header，并在你的业务逻辑中使用它们。
  • 你可以从生成的代码启动服务器。有一个README.md文件描述了启动服务器的先决条件和说明。
  • 阅读框架的相关文档，了解有关配置或自定义生成的代码的更多详细信息。

只生成路由和接口​

除了为每个端点的实现配置路由和存根而生成的代码外，生成的代码还包括其他文件，如README.md依赖项列表、服务器设置代码和所选框架所需的其他项目。这些文件通常在代码生成后进行编辑和定制。

你可以在生成代码时选择仅生成路由和接口选项。这将生成与 OpenAPI 架构中的路径和组件相关的代码，并忽略其他文件。这使你能够更新与新的或更改的端点相关的文件，并避免使用生成的样板代码覆盖你的自定义文件。