自动生成代码

视频内容

功能说明

基于接口定义，Apifox 支持自动生成各种语言和框架的业务代码，包括但不限于 TypeScript、Java、Go、Swift、ObjectiveC、Kotlin、Dart、C++、C#、Rust 等 130 种语言和框架。

自动生成的业务代码包括 Model、Controller、单元测试代码等。无需手动编写就能够在接口设计页中快速生成符合标准的接口请求代码，确保生成的代码与接口模型定义的一致性。

不仅如此，你还可以通过“自定义代码模板”功能生成符合自己团队的架构规范的代码，满足各种个性化的需求。

生成接口请求代码

接口请求代码用于在各个开发环境中发起接口请求。点击接口中的“文档” tab 页右侧的“生成接口请求代码”按钮。

你也可以点击接口中的“运行” tab 页中的代码图标生成代码。

在接口中也同样可以快速生成代码。

你可以在代码生成页中快速选择不同环境中的代码。

生成业务代码

业务代码指的是实现某个业务逻辑的源代码，它是一个系统中最重要的组成部分之一，通常运行在服务器中，负责实现业务需求、数据处理和逻辑控制。

前提条件

1. Apifox 插件

2. Java 环境

生成特定接口业务代码

在“文档”页，鼠标移动至“生成代码”按钮位置，点击“生成业务代码”按钮。

也可将鼠标移至左侧菜单栏内的接口或目录上，点击鼠标右键，在弹出框中选择“生成业务代码”选项。

导出业务代码前要求本机已安装插件。点击业务代码生成页中的“下载并安装”按钮。

在弹出的界面中选择需要的服务器端业务代码。可以生成全部接口或者部分接口，也可以通过标签来筛选接口。

Apifox 自定义模板简化了自定义代码生成模板目录的使用，避免了处理命令行的问题。其内部基于 OpenAPI Generator，因此相关写法可参考相关教程。

1. 完全自定义的成本很高：建议先参考官方模板进行改造，上面有很多参考的自定义模板变量： openapi-generator/samples/server/petstore at master · OpenAPITools/openapi-generator，如 Springboot 3 的模板：openapi-generator/samples/server/petstore/kotlin-springboot-3 at master · OpenAPITools/openapi-generator。
2. 社区教程：建议先观看视频教程，更容易上手：视频教程。

大致操作步骤：

1. 将您想要覆盖的模板下载到一个目录中，例如目录 A。
2. 按照视频教程和指南 OpenAPI Generator Templating 修改模板。
3. 在 GUI 中生成代码时，选择 自定义模板 并选择目录 A。

生成数据模型代码

数据模型代码用于定义数据结构，常用于 API 发送数据时的序列化以及接收数据后的反序列化处理。生成 SQL 代码类型后，在数据库建表场景下还支持定义建表语句，用于在数据库中创建数据表。

访问数据模型，轻点模型页中的“生成代码”选项。

模型代码支持多种代码类型。

完整的代码类型列表：

C#	C++	Crystal	Dart	Elm	Flow
Go	Haskell	Java	JavaScript	Kotlin	Objective-C
Pike	Python	Ruby	Rust	SQL	Swift
TypeScript

SQL 建表语句

支持快速生成数据模型代码，包括 SQL 建表语句。点击“生成代码”按钮，选择 SQL 代码类型即可查看建表语句。