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便可以看到