代码优先还是设计优先?说说API开发技术(二)

举报
Jet Ding 发表于 2021/07/26 09:26:26 2021/07/26
【摘要】 【设计优先:OpenAPI生成器】  这一节要讨论的内容是如何通过API设计来生成客户端访问和服务器端的存根代码。 OpenAPI Generator可以自动生成API客户端库(SDK)、服务器存根、文档和配置(支持2.0和3.0)。 【安装】在这篇文章编写的时刻,最稳定的OpenAPI版本是4.3.0。 Maven 安装核心程序:        <dependency>          ...

【设计优先:OpenAPI生成器

91.jpg 

 

这一节要讨论的内容是如何通过API设计来生成客户端访问和服务器端的存根代码。 

OpenAPI Generator可以自动生成API客户端库(SDK)、服务器存根、文档和配置(支持2.03.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://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.0/openapi-generator-cli-4.3.0.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

【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。