Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。http://swagger.io/
    Beego+Swagger 实现API自动化文档
    步骤：
    第一步：下载Swagger资源包，下载地址 https://github.com/beego/swagger ，将下载好的资源包放入项目swagger目录下。
    第二步：修改main.go文件

    1. package main
    3. import (
    4.     _ "user_center_go/routers"
    6.     "github.com/astaxie/beego"
    7. )
    9. func main() {
    10.     if beego.BConfig.RunMode == "dev" {
    11.         beego.BConfig.WebConfig.DirectoryIndex = true
    12.         beego.BConfig.WebConfig.StaticDir["/swagger"] = "swagger"
    13.     }
    14.     beego.Run()
    15. }

    第三步：修改router.go文件的路由注册方式，采用命名空间方式，且只支持两级路由；文件头部添加Swagger文件注解，用于声明API的作用。

    1. // @APIVersion 版本号
    2. // @Title 标题
    3. // @Description 描述
    4. // @Contact 联系方式
    5. // @TermsOfServiceUrl 团队服务地址
    6. // @License 许可
    7. // @LicenseUrl 许可网址
    8. package routers
    10. import (
    11.     "user_center_go/controllers"
    13.     "github.com/astaxie/beego"
    14. )
    16. func init() {
    17.     ns := beego.NewNamespace("/user-center",
    18.         beego.NSNamespace("/token",
    19.             beego.NSInclude(
    20.                 &controllers.TokenController{},
    21.             ),
    22.         ),
    23.         beego.NSNamespace("/user",
    24.             beego.NSInclude(
    25.                 &controllers.UserController{},
    26.             ),
    27.         ),
    28.     )
    29.     beego.AddNamespace(ns)
    30. }

    第四步：给API Controller 添加注解

    1. package controllers
    3. import (
    4.     "encoding/json"
    5.     "user_center_go/models"
    7.     "github.com/astaxie/beego"
    8. )
    10. // 用户信息
    11. type UserController struct {
    12.     beego.Controller
    13. }
    15. // @Title 获取用户基本信息
    16. // @Description 获取用户基本信息
    17. // @Param    Authorization        header     string    true        "令牌，包含在请求头信息中"
    18. // @Success 200 {object} models.ApiResult "ok"
    19. // @Failure 400 {object} models.ApiResult "paras missing"
    20. // @Failure 500 {object} models.ApiResult "do not have this job"
    21. // @router /baseInfo [get]
    22. func (c *UserController) BaseInfo() {
    23.     // 取出用户编号
    24.     userId := c.Ctx.Input.GetData("userId")
    25.     baseInfo := models.GetUserBaseInfo(userId.(string))
    27.     c.Data["json"] = models.ApiResult{Code: SUCCESS, Message: "查询成功", Data: baseInfo}
    28.     c.ServeJSON()
    29. }

    第五步：启动

    1. bee run -gendoc=true -downdoc=true

    第六步：访问
    http://localhost:8080/swagger