OpenAPI初探

2019-08-29 19:42:21 浏览数 (1)

项目中使用gin组件实现的api接口,总是需要修改代码,又要修改md文档。总想有没有一种办法,能够只写一遍就能完成代码和文档的修改,很快发现了gin-swagger组件,可以通过代码的注释生成文档,但写代码同时写入详细的注释让人发狂。

很快发现openapi可以通过写标准的yaml,可以通过yaml生成代码和文档。

Openapi yaml的格式如下:

编辑好yaml,使用如下命令:

docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate -i /local/petstore.yaml -g go-gin-server -o /local/output

自动生成go server的代码,包含model和api,文档等。

在框架中加入后端业务实现,一个标准的后端服务完成了。如果需要更改接口,更新yaml重新生成代码和文档就行了。

也许指定的模板不符合你的框架,也可以下载开源的代码生成工具:https://github.com/OpenAPITools/openapi-generator

在模板目录下,增加对应的mustache模板文件,就可以支持新的框架代码生成了。

0 人点赞