生成服务器代码

通过服务器代码生成,您可以从 OpenAPI 3 规范生成服务器端样板代码。这启用了 API 优先的开发方法,您可以在其中下载基于 API 规范的正在运行的服务器,并将其用作开发业务逻辑的起点。

支持的语言和框架包括:

  • Go - Chi 服务器
  • NodeJS - 表达
  • Java - JAX-RS
  • Python - 烧瓶

生成服务器代码

要从您的 OpenAPI 3 规范生成服务器端样板:

  1. 导航到 API 选项卡。
  2. 选择一个包含 OpenAPI 3 规范的 API。
  3. 在右侧边栏中,选择代码生成图标</>编辑 API
  4. 在“代码生成”面板中,选择要为其生成样板的语言和框架,然后选择“生成代码”按钮。

生成的代码将自动下载为 zip 存档。您可能需要打开浏览器的“下载”选项才能找到存档。文件的名称包括生成代码的 API 的名称以及选择的语言和框架。

使用生成的代码

生成的代码结构将取决于您选择的语言。所有受支持的语言都将涵盖 OpenAPI 3.0 规范中的一些主要功能。以下是您可以从生成的代码中获得的一些功能:

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

仅生成路由和接口

除了为每个端点的实现配置路由和存根生成的代码外,生成的代码还将包括其他文件,如README.md、依赖项列表、服务器设置代码以及所选特定框架所需的其他项目。这些生成的文件很可能会在代码生成后由您编辑和自定义。

下载生成的代码时,您可以选择仅生成路由和接口选项。这只会生成与 OpenAPI 模式中的路径和组件相关的代码,而忽略所有其他文件。这将使您能够仅更新与新的或更改的端点相关的文件,并避免使用生成的样板代码覆盖您的自定义文件。