openapi generator(入门)

零.介绍

传统的API是由后端先开发完，其他使用方等待后端开发完后再接入开发。

而openapi的出现目的是作为一种API契约，在开发前先统一好API规范，然后双方可以并行进行开发

 

 

一.安装

通过npm安装，其他安装方式请见：https://openapi-generator.tech/docs/installation/

# 安装脚手架
npm install @openapitools/openapi-generator-cli -g
# 设置使用的版本
openapi-generator-cli version-manager set 5.3.0
# 添加依赖
npm install @openapitools/openapi-generator-cli -D

二.支持生成

OpenAPI Generator 配备了25多个服务器存根生成器，包括各种语言热门的框架，如：

• go-gin-server

• python-flask

更多请见：https://openapi-generator.tech/docs/generators/

三.编写yaml文件

可以使用编辑工具边写边看效果，vscode可以添加openapi插件支持。

或者使用 insomnia Designer ：https://insomnia.rest/product/design

具体编写规范可以参考 :https://openapi.apifox.cn/

演示示例：petstore.yaml 

四.生成gin代码

# 官方提供openapi-generator命令格式如下
npx @openapitools/openapi-generator-cli generate -i petstore.yaml -g go-gin-server -o F://openapi-test/
# -i petstore.yaml 表示要根据哪个文档生成，支持yaml和json
# -g go-gin-server          表示生成gin
# -o F://openapi-test/    指定存放的地址

生成内容：

 五.运行

cd openapi-test
#初始化模块
go mod init openapi-test
go mod tidy

#修改'main.go'中的import 路径
#sw ".go"  改成 sw "openapi-test\go"

#运行
go run .

访问：