生成代码

基于 API 规范，Apidog 支持为各种语言和框架自动生成业务代码，包括但不限于 TypeScript、Java、Go、Swift、Objective-C、Kotlin、Dart、C++、C#、Rust 以及其他 130 多种语言和框架。

Apidog 提供三种代码生成类型：生成服务器存根和客户端 SDK、生成客户端代码 和 生成数据模型代码。

生成服务器存根和客户端 SDK：服务器存根面向 API 开发者，而客户端 SDK 面向 API 使用者。此功能会生成服务器端和客户端代码。服务器存根是服务器上 API 端点的骨架实现，而客户端 SDK 是用于不同编程语言与 API 交互的预构建库。

生成客户端代码：面向 API 使用者。创建用于客户端应用程序与 API 交互的代码。

生成数据模型代码：面向 API 使用者。生成 API 中使用的数据结构的代码表示。这包括定义请求和响应对象结构的类或结构体，有助于确保整个应用程序中的类型安全和一致性。

生成服务器存根和客户端 SDK

Apidog 中的 生成服务器存根和客户端 SDK 功能可帮助开发者基于平台内定义的 API 规范，自动生成服务器端代码存根和客户端 SDK，从而简化 API 实现流程。

服务器存根是可用于快速启动服务器端应用程序的代码模板，为实现指定的 API 端点、请求处理和响应生成提供基础。另一方面，客户端 SDK 提供了用于从客户端与 API 交互的预配置代码片段，简化了将 API 功能集成到各种应用程序中的过程。

如何生成

1. 安装代码生成插件

在 API 规范中点击 生成代码，然后选择 生成服务器存根和客户端 SDK。

在业务代码生成页面中点击 下载并安装 按钮。

NOTE

如果你的网络无法访问互联网，请从以下地址手动下载 openapi-generator-cli-7.13.0.jar：
https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.13.0/openapi-generator-cli-7.13.0.jar

然后将 JAR 文件放置到你系统对应的以下目录中：

macOS：~/Library/Application Support/apidog/

Windows：C:\Users\<USERNAME>\AppData\Roaming\apidog\

Linux：~/.config/apidog/

插件会自动检测并使用本地 JAR，因此不需要互联网连接。

2. 生成代码

选择所需的服务器或客户端代码，然后点击 生成代码。

3. 使用自定义模板

你还可以使用 自定义代码模板 功能生成符合团队架构规范的代码，以满足各种个性化需求。

支持的语言/框架

语言	服务器/客户端	框架
Java	服务器	Spring, Inflector, Msf4j, Pkmst, Play Framework, Undertow Server, Vertx, Vertx Web, JAX-RS Cxf, JAX-RS Cxf Cdi, JAX-RS Cxf Extended, JAX-RS Jersey, JAX-RS Resteasy, JAX-RS Resteasy Eap, JAX-RS Spec
Java	客户端	Android, Java
PHP	服务器	Laravel, Lumen, Symfony, Ze Ph, Slim4, Slim (Deprecated), Silex (Deprecated)
PHP	客户端	PHP
Swift	客户端	Swift5, Swift4, Swift3 (Deprecated), Swift2 (Deprecated)
Kotlin	服务器	Kotlin Server, Kotlin Spring, Kotlin Vertx
Kotlin	客户端	Kotlin
JavaScript	客户端	Apollo, Flowtyped, Closure Angular
Node.js	服务器	Express, GraphQL Express
TypeScript	客户端	Axios, Fetch, Redux Query, Angular, Angularjs, Jquery, Rxjs, Node, Aurelia, Inversify
C++	服务器	Pistache Server, Qt5 Qhttpengine Server, Restbed Server
C++	客户端	Qt5 Client, Restsdk, Tizen
C#	服务器	C# Nancyfx
C#	客户端	C#, C# Netcore, C# Dotnet2
ASP.NET	服务器	ASP.NET Core
Dart	客户端	Dart, Dart Dio, Dart Jaguar
Go	服务器	Go Server, Go Gin Server
Go	客户端	Go, Go (Experimental)
C	客户端	C
Objective-C	客户端	Objective-C
Scala	服务器	Scala Akka Http Server, Scala Finch, Scala Lagom Server, Scala Play Server
Scala	客户端	Scala Akka, Scala Gatling, Scala Sttp, Scalaz, Scala Httpclient (Deprecated)
Clojure	客户端	Clojure
Groovy	客户端	Groovy
Python	服务器	Python Aiohttp, Python Blueplanet, Python Flask
Python	客户端	Python, Python (Experimental)
Rust	服务器	Rust Server
Rust	客户端	Rust
Ruby	服务器	Ruby On Rails, Ruby Sinatra
Ruby	客户端	Ruby
R	客户端	R
Perl	客户端	Perl
PowerShell	客户端	PowerShell
JMeter	客户端	JMeter
Bash	客户端	Bash
Lua	客户端	Lua
F#	服务器	F# Functions, F# Giraffe Server
OCaml	客户端	OCaml
Erlang	服务器	Erlang Server
Erlang	客户端	Erlang Client, Erlang Proper
Flash	客户端	Flash
Elixir	客户端	Elixir
Haskell	服务器	Haskell
Haskell	客户端	Haskell Http Client
Elm	客户端	Elm
Nim	客户端	Nim
Ada	服务器	Ada Server
Ada	客户端	Ada
Apex	客户端	Apex
Eiffel	客户端	Eiffel

TIP

Apidog 代码模板的功能基于 OpenAPI Generator，但进行了简化。你可以参考这个 Youtube Video，了解更多关于 OpenAPI generator 模板规则的信息。

生成客户端代码

客户端代码用于在各种开发环境中发起 API 请求。在 API 的文档标签页右侧点击 生成客户端代码 按钮。

你也可以在 API 的运行标签页中点击代码图标 </> 来生成代码。

NOTE

使用上述方法生成的客户端代码将仅包含 API 规范，而不包含请求参数值。如果你想生成包含请求参数值的客户端代码，需要先发送请求，然后切换到 实际请求 标签页。向下滚动即可找到包含参数值的客户端代码。

支持的语言

语言	变体
Shell	cURL, cURL-Windows, Httpie, wget, PowerShell
JavaScript	Fetch, Axios, jQuery, XHR, Native, Request , Unirest
Java	Unirest, OkHttp
Swift	URLSession
Go	Native
PHP	cURL, Guzzle, pecl_http, HTTP_Request2
Python	http.client, Requests
HTTP	HTTP
C	libcurl
C#	RestSharp
Objective-C	NSURLSession
Ruby	Net::HTTP
OCaml	Cohttp
Dart	http
R	httr, RCurl

生成数据模型代码

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

要访问数据模型，请在 Schema Editor 中点击 生成代码 按钮。

随后，你可以为生成的代码选择所需的编程语言，并配置特定的代码风格偏好。

支持的语言

C#
C++
Crystal
Dart
Elm

Flow
Go
Haskell
Java
JavaScript

Kotlin
Objective-C
Pike
Python
Ruby

Rust
SQL
Swift
TypeScript

在 API 文档中生成代码

在 Apidog 生成的 API 文档中，你可以轻松生成 客户端代码 和 数据模型代码。

生成服务器存根和客户端 SDK#

如何生成#

支持的语言/框架#

生成客户端代码#

支持的语言#

生成数据模型代码#

支持的语言#

在 API 文档中生成代码#

生成服务器存根和客户端 SDK

如何生成

支持的语言/框架

生成客户端代码

支持的语言

生成数据模型代码

支持的语言

在 API 文档中生成代码