beego api接口文档自动化

1、修改配置文件，添加以下配置

EnableDocs = true

2、执行以下命令初始化swagger文档目录

bee generate docs

3、下载swagger插件，并上传到上一步生成的swagger目录中，点击这里下载
4、修改swagger目录下index.html，修改结果如下图：

以下配置过程参考beego官网文档

5、修改routers/router.go配置，文件最顶部添加以下信息，可根据个人需求修改

// @APIVersion 1.0.0
// @Title mobile API
// @Description mobile has every tool to get any job done, so codename for the new mobile APIs.
// @Contact astaxie@gmail.com
package routers

6、配置router及controller信息，例如：

func init() {
	ns :=
	    beego.NewNamespace("/v1",
		    beego.NSNamespace("/user",
		        beego.NSInclude(
			        &controllers.UserController{},
		        ),
		    ),
	    )
	beego.AddNamespace(ns)
}

对应的controller配置如下：

func (c *UserController) URLMapping()  {
	c.Mapping("User_List", c.User_List)
	c.Mapping("User_Edit", c.User_Edit)
	c.Mapping("User_Add", c.User_Add)
}
//@Title User_list
//@Description Get all user list
//@router /list [Get]    #根据个人需求增删改
func (c *UserController) User_List()  {    #这里需要注意，函数和抬头标签部分中间不要有空行
}										   #否则无法生成接口文档
//@Title User_Edit
//@Description Update user info
//@router /edit [Post]
func (c *UserController) User_Edit()  {
}
//@Title User_Add
//@Description Add new user
//@router /add [Post]
func (c *UserController) User_Add() {
}

7、完成上述配置后，执行命令重新生成文档

bee generate docs

8、运行程序，访问接口地址查看生成接口情况
http://ip:端口/swagger/index.html
示例如下：