目录

swagger和swag和gin-swagger之间的关系

概述

很多人不太理解 swagger, swag, gin-swagger 的关系,本文简单总结一下。

区别

  1. swagger: 可以理解成一个用于生成、描述和调用RESTful接口的服务,也就是我们经常见到的swagger页面,可见的文件格式就是swagger.json, swagger.yaml之类的接口描述文件,swagger不区分语言,事实上大部分的语言都有生成swagger接口描述文件的工具,主要的工具都是用Java来写的
  2. swag: 可以理解成是一个用Go写的一个将Go的注释转化成上述说的swagger接口的描述文件的工具
  3. go-swagger: 有点类似官方的swagger codegen,可以生成页面、接口文档、客户端,只是开发的语言为Go
  4. gin-swagger: gin是一个Go写的Web框架,但是不提供接口文档工具,所以gin-swagger就是一个帮助用gin写的Web后台转化成swagger接口描述文件的工具

参考资料

  1. swagger
  2. swag
  3. go-swagger
  4. gin-swagger
警告
本文最后更新于 2021年6月7日,文中内容可能已过时,请谨慎参考。