name: API 自动化文档

sort: 2

API自动化文档

自动化文档一直是我梦想中的一个功能,这次借着公司的项目终于实现了出来,我说过 beego 不仅仅要让开发 API 快,而且让使用 API 的用户也能快速的使用我们开发的 API,这个就是我开发这个项目的初衷。好了,赶紧动手实践一把吧,首先 bee api beeapi 新建一个 API 应用做起来吧。

API 全局设置

必须设置在 routers/router.go 中,文件的注释,最顶部:

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

全局的注释如上所示,是显示给全局应用的设置信息,有如下这些设置

  • @APIVersion
  • @Title
  • @Description
  • @Contact
  • @TermsOfServiceUrl
  • @License
  • @LicenseUrl

路由解析须知

目前自动化文档只支持如下的写法的解析,其他写法函数不会自动解析,即 namespace+Include 的写法,而且只支持二级解析,一级版本号,二级分别表示应用模块

  1. func init() {
  2. ns :=
  3. beego.NewNamespace("/v1",
  4. beego.NSNamespace("/customer",
  5. beego.NSInclude(
  6. &controllers.CustomerController{},
  7. &controllers.CustomerCookieCheckerController{},
  8. ),
  9. ),
  10. beego.NSNamespace("/catalog",
  11. beego.NSInclude(
  12. &controllers.CatalogController{},
  13. ),
  14. ),
  15. beego.NSNamespace("/newsletter",
  16. beego.NSInclude(
  17. &controllers.NewsLetterController{},
  18. ),
  19. ),
  20. beego.NSNamespace("/cms",
  21. beego.NSInclude(
  22. &controllers.CMSController{},
  23. ),
  24. ),
  25. beego.NSNamespace("/suggest",
  26. beego.NSInclude(
  27. &controllers.SearchController{},
  28. ),
  29. ),
  30. )
  31. beego.AddNamespace(ns)
  32. }

应用注释

接下来就是我们最重要的注释了,就是我们定义的,我们先来看一个例子:

  1. package controllers
  2. import "github.com/astaxie/beego"
  3. // CMS API
  4. type CMSController struct {
  5. beego.Controller
  6. }
  7. func (c *CMSController) URLMapping() {
  8. c.Mapping("StaticBlock", c.StaticBlock)
  9. c.Mapping("Product", c.Product)
  10. }
  11. // @Title getStaticBlock
  12. // @Description get all the staticblock by key
  13. // @Param key path string true "The email for login"
  14. // @Success 200 {object} models.ZDTCustomer.Customer
  15. // @Failure 400 Invalid email supplied
  16. // @Failure 404 User not found
  17. // @router /staticblock/:key [get]
  18. func (c *CMSController) StaticBlock() {
  19. }
  20. // @Title Get Product list
  21. // @Description Get Product list by some info
  22. // @Success 200 {object} models.ZDTProduct.ProductList
  23. // @Param category_id query int false "category id"
  24. // @Param brand_id query int false "brand id"
  25. // @Param query query string false "query of search"
  26. // @Param segment query string false "segment"
  27. // @Param sort query string false "sort option"
  28. // @Param dir query string false "direction asc or desc"
  29. // @Param offset query int false "offset"
  30. // @Param limit query int false "count limit"
  31. // @Param price query float false "price"
  32. // @Param special_price query bool false "whether this is special price"
  33. // @Param size query string false "size filter"
  34. // @Param color query string false "color filter"
  35. // @Param format query bool false "choose return format"
  36. // @Failure 400 no enough input
  37. // @Failure 500 get products common error
  38. // @router /products [get]
  39. func (c *CMSController) Product() {
  40. }

首先是 CMSController 定义上面的注释,这个是用来显示这个模块的作用。接下来就是每一个函数上面的注释,这里列出来支持的各种注释:

  • @Title

    这个 API 所表达的含义,是一个文本,空格之后的内容全部解析为 title

  • @Description

    这个 API 详细的描述,是一个文本,空格之后的内容全部解析为 Description

  • @Param

    参数,表示需要传递到服务器端的参数,有五列参数,使用空格或者 tab 分割,五个分别表示的含义如下

    1. 参数名
    2. 参数类型,可以有的值是 formData、query、path、body、header,formData 表示是 post 请求的数据,query 表示带在 url 之后的参数,path 表示请求路径上得参数,例如上面例子里面的 key,body 表示是一个 raw 数据请求,header 表示带在 header 信息中得参数。
    3. 参数类型
    4. 是否必须
    5. 注释
  • @Success

    成功返回给客户端的信息,三个参数,第一个是 status code。第二个参数是返回的类型,必须使用 {} 包含,第三个是返回的对象或者字符串信息,如果是 {object} 类型,那么 bee 工具在生成 docs 的时候会扫描对应的对象,这里填写的是想对你项目的目录名和对象,例如 models.ZDTProduct.ProductList 就表示 /models/ZDTProduct 目录下的 ProductList 对象。

    三个参数必须通过空格分隔

  • @Failure

    失败返回的信息,包含两个参数,使用空格分隔,第一个表示 status code,第二个表示错误信息

  • @router

    路由信息,包含两个参数,使用空格分隔,第一个是请求的路由地址,支持正则和自定义路由,和之前的路由规则一样,第二个参数是支持的请求方法,放在 [] 之中,如果有多个方法,那么使用 , 分隔。

如何自动化生成文档

要使得文档工作,你需要做几个事情,

  • 第一开启应用内文档开关,在配置文件中设置:EnableDocs = true,
  • 然后在你的 main.go 函数中引入 _ "beeapi/docs"(beego 1.7.0 之后版本不需要添加该引用)。
  • 这样你就已经内置了 docs 在你的 API 应用中,然后你就使用 bee run -gendoc=true -downdoc=true,让我们的 API 应用跑起来,-gendoc=true 表示每次自动化的 build 文档,-downdoc=true 就会自动的下载 swagger 文档查看器

好了,现在打开你的浏览器查看一下效果,是不是已经完美了。下面是我的 API 文档效果:

API自动化文档 - 图1

API自动化文档 - 图2

可能遇到的问题

  1. CORS 两种解决方案:

    • 把 swagger 集成到应用中,下载请到swagger,然后放在项目目录下:

      1. if beego.BConfig.RunMode == "dev" {
      2. beego.BConfig.WebConfig.DirectoryIndex = true
      3. beego.BConfig.WebConfig.StaticDir["/swagger"] = "swagger"
      4. }
    • API 增加 CORS 支持

      1. ctx.Output.Header("Access-Control-Allow-Origin", "*")
  2. 未知错误,因为这是我自己项目中使用的,所以可能大家在写的过程中会遇到一些莫名的错误,请提 issue 去吧!