代码优先还是设计优先?说说API开发技术(二)
【设计优先:OpenAPI生成器】
这一节要讨论的内容是如何通过API设计来生成客户端访问和服务器端的存根代码。
OpenAPI Generator可以自动生成API客户端库(SDK)、服务器存根、文档和配置(支持2.0和3.0)。
【安装】
在这篇文章编写的时刻,最稳定的OpenAPI版本是4.3.0。
Maven 安装
核心程序:
<dependency>
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator</artifactId>
<version>${openapi-generator-version}</version>
</dependency>
命令行:
<dependency>
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator-cli</artifactId>
<version>${openapi-generator-version}</version>
</dependency>
Maven插件:
<dependency>
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator-maven-plugin</artifactId>
<version>${openapi-generator-version}</version>
</dependency>
Gradle插件:
<dependency>
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator-gradle-plugin</artifactId>
<version>${openapi-generator-version}</version>
</dependency>
手工安装
直接下载核心程序jar包。
脚本下载:
https://github.com/OpenAPITools/openapi-generator/blob/master/bin/utils/openapi-generator-cli.sh
源码编译安装
从此处下载源码:
https://github.com/OpenAPITools/openapi-generator.git
运行如下命令:
mvn clean install
Homebrew 安装
brew install openapi-generator
Docker 安装
Docker镜像:
https://hub.docker.com/r/openapitools/openapi-generator-cli/
https://hub.docker.com/r/openapitools/openapi-generator-online/
openapi-generator-online镜像可以作为一个自托管的web应用和API来生成代码。这个容器可以被整合到CI流水线中,至少需要两个HTTP请求和一些docker 生态来访问生成的代码。
NPM 安装
npm install @openapitools/openapi-generator-cli -g
- 点赞
- 收藏
- 关注作者
评论(0)