golang gin框架 使用swagger生成api文档

golang gin框架 使用swagger生成api文档

• swagger介绍

  • 是一款能更好书写API文档的规范且完整的框架
  • 提供描述、运行，可视化

• swag使用

  • swag下载

  go get -u github.com/swaggo/swag/cmd/swag
  
  这一步要是不行。就按照下面的步骤下载
  git clone https://github.com/swaggo/swag.git(记得要放在GOPATH中)
  进入github.com\swaggo\swag\cmd\swag文件夹下，运行go install
  

  • 下载gin-swagger

  go get -u github.com/swaggo/gin-swagger
  go get -u github.com/swaggo/files
  

  • gin-swagger文件夹下有一个exmple文件夹，用来测试用的，这里我们进入basic文件夹

  

  • 在这个目录下运行该项目执行swag init命令后

  

  • 然后运行整个项目

    go run main.go
    

  • 在浏览器中输入：http://localhost:8080/swagger/index.html便可以看到