beego API开发以及自动化文档

原创
2014/06/25 15:42
阅读数 7.9W

beego API开发以及自动化文档

beego1.3版本已经在上个星期发布了,但是还是有很多人不了解如何来进行开发,也是在一步一步的测试中开发,期间QQ群里面很多人都问我如何开发,我的业余时间实在是排的太满了,实在是没办法一一回复大家,在这里和大家说声对不起,这两天我又不断的改进,写了一个应用示例展示如何使用beego开发API已经自动化文档和测试,这里就和大家详细的解说一下。

自动化文档开发的初衷

我们需要开发一个API应用,然后需要和手机组的开发人员一起合作,当然我们首先想到的是文档先行,我们也根据之前的经验写了我们需要的API原型文档,我们还是根据github的文档格式写了一些漂亮的文档,但是我们开始担心这个文档如果两边不同步怎么办?因为毕竟是原型文档,变动是必不可少的。手机组有一个同事之前在雅虎工作过,他推荐我看一个swagger的应用,看了swagger的标准和文档化的要求,感觉太棒了,这个简直就是神器啊,通过swagger可以方便的查看API的文档,同时使用API的用户可以直接通过swagger进行请求和获取结果。所以我就开始学习swagger的标准,同时开始进行Go源码的研究,通过Go里面的AST进行源码分析,针对comments解析,然后生成swagger标准的json格式,这样最后就可以和swagger完美结合了。

这样做的好处有三个:

  1. 注释标准化

  2. 有了注释之后,以后API代码维护相当方便

  3. 根据注释自动化生成文档,方便调用的用户查看和测试

beego API应用入门

请大家更新到最新的bee和beego

go get -u github.com/beego/bee
go get -u github.com/astaxie/beego

然后进入到你的GOPATH/src目录,执行命令bee api bapi,进入目录cd bapi,执行命令bee run -downdoc=true -docgen=true.请看下面我执行的效果图:

执行完成之后就打开浏览器,输入URL:http://127.0.0.1:8080/swagger/swagger-1/

记住这里必须要用127.0.0.1,不能使用localhost,存在CORS问题,Ajax跨域

我们的效果和应用都出来了,很酷很炫吧,那这后面到底采用了怎么样的一些技术呢?让我们一步一步来讲解这些细节:

项目目录

我们首先来了解一下bee api创建的应用的目录结构:

|-- bapi
|-- conf
|   `-- app.conf
|-- controllers
|   |-- object.go
|   `-- user.go
|-- docs
|   |-- doc.go
|   `-- docs.go
|-- lastupdate.tmp
|-- main.go
|-- models
|   |-- object.go
|   `-- user.go
|-- routers
|   |-- commentsRouter.go
|   `-- router.go
|-- swagger
`-- tests
    `-- default_test.go
  • main.go 是程序的统一入口文件

  • bapi 是生成的二进制文件

  • conf 配置文件目录,app.conf

  • controllers 控制器目录,主要是逻辑的处理

  • models 是数据处理层的目录

  • docs 是自动化生成文档的目录

  • lastupdate.tmp 是一个注解路由的缓存文件

  • routers是路由目录,主要涉及一些路由规则

  • swagger 是一个html静态资源目录,是通过bee自动下载的,主要就是展示我们看到的界面及测试

  • test 目录是针对应用的测试用例,beego相比其他revel框架的好处之一就是无需启动应用就可以执行test case。

入口文件main

我们第一步先来看一下入口是怎么写的?

package main

import (
    _ "bapi/docs"
    _ "bapi/routers"

    "github.com/astaxie/beego"
)

func main() {
    if beego.RunMode == "dev" {
        beego.DirectoryIndex = true
        beego.StaticDir["/swagger"] = "swagger"
    }
    beego.Run()
}

入口文件就是一个普通的beego应用的标准代码,只是这里多了几行代码,把swagger加入了static,因为我们需要把文档服务器集成到beego的API应用中来。然后增加了docs的初始化引入,和router的效果一样。接下里我们先来看看自动化API的路由是怎么设计的

namespace路由

自动化路由才有了namespace来进行设计,而且注意两点,第一目前只支持namespace的路由支持自动化文档,第二只支持NSNamespace和NSInclude解析,而且是只能两个层级,先看我们的路由设置:

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

我们先来看一下这个代码,首先是使用beego.NewNamespace创建一个ns的变量,这个变量里面其实就是存储了一棵路由树,我们可以把这棵树加到其他任意已经存在的树中去,这也就是namespace的好处,可以在任意的模块中设计自己的namespace,然后把这个namespace加到其他的应用中去,可以增加任意的前缀等。

这里我们分析一下NewNamespace这个函数,这个函数的定义是这样的NewNamespace(prefix string, params ...innnerNamespace) *Namespace,他的第一个参数就是前缀,第二个参数是innnerNamespace多参数,那么我们来看看innnerNamespace的定义是什么:

type innnerNamespace func(*Namespace)

它是一个函数,也就是只要是符合参数是*Namespace的函数都可以。那么在beego里面定义了如下的方法支持返回这个函数类型:

  • NSCond(cond namespaceCond) innnerNamespace

  • NSBefore(filiterList ...FilterFunc) innnerNamespace

  • NSAfter(filiterList ...FilterFunc) innnerNamespace

  • NSInclude(cList …ControllerInterface) innnerNamespace

  • NSRouter(rootpath string, c ControllerInterface, mappingMethods …string) innnerNamespace

  • NSGet(rootpath string, f FilterFunc) innnerNamespace

  • NSPost(rootpath string, f FilterFunc) innnerNamespace

  • NSDelete(rootpath string, f FilterFunc) innnerNamespace

  • NSPut(rootpath string, f FilterFunc) innnerNamespace

  • NSHead(rootpath string, f FilterFunc) innnerNamespace

  • NSOptions(rootpath string, f FilterFunc) innnerNamespace

  • NSPatch(rootpath string, f FilterFunc) innnerNamespace

  • NSAny(rootpath string, f FilterFunc) innnerNamespace

  • NSHandler(rootpath string, h http.Handler) innnerNamespace

  • NSAutoRouter(c ControllerInterface) innnerNamespace

  • NSAutoPrefix(prefix string, c ControllerInterface) innnerNamespace

  • NSNamespace(prefix string, params …innnerNamespace) innnerNamespace

因此我们可以在NewNamespace这个函数的第二个参数列表中使用上面的任意函数作为参数调用。

我们看一下路由代码,这是一个层级嵌套的函数,第一个参数是/v1,即为/v1开头的路由树,第二个参数是beego.NSNamespace,第三个参数也是beego.NSNamespace,也就是路由树嵌套了路由树,而我们的beego.NSNamespace里面也是和NewNamespace一样的参数,第一个参数是路由前缀,第二个参数是slice参数。这里我们调用了beego.NSInclude来进行注解路由的引入,这个函数是专门为注解路由设计的,我们可以看到这个设计里面我们没有任何的路由信息,只是设置了前缀,那么这个的路由是在哪里设置的呢?我们接下来分析什么是注解路由。

注解路由

可能有些同学不了解什么是注解路由,也就是在Controller类上添加一个注释让框架给自动添加Route,那么我们来看一下ObjectControllerUserController中怎么写路由注解的:

// Operations about object
type ObjectController struct {
    beego.Controller
}

// @Title create
// @Description create object
// @Param   body        body    models.Object   true        "The object content"
// @Success 200 {string} models.Object.Id
// @Failure 403 body is empty
// @router / [post]
func (this *ObjectController) Post() {
    var ob models.Object
    json.Unmarshal(this.Ctx.Input.RequestBody, &ob)
    objectid := models.AddOne(ob)
    this.Data["json"] = map[string]string{"ObjectId": objectid}
    this.ServeJson()
}

我们看到我们的每一个函数上面有大段的注释,注解路由其实主要关注最后一行// @router / [post],这一行的注释就是表示这个函数是注册到路由/,支持方法是post

和我们平常的时候使用beego.Router("/", &ObjectController{},"post:Post")的效果是一模一样的,只是这一次框架帮你自动注册了这样的路由,框架是如何来自动注册的呢?在应用启动的时候,会判断是否有调用NSInclude,在调用的时候,判断RunMode是否是dev模式,是的话就会判断是否之前有分析过,并且分析对象目录有更新,就使用Go的AST进行源码分析(当然只分析NSInclude调用的controller),然后生成文件routers/commentsRouter.go,在该文件中会自动注册我们需要的路由信息。这样就完成了整个的注解路由注册。

注解路由是使用// @router 开头来申明的,而且必须放在你要注册的函数的上方,和其他注释@Title @Description的顺序无关,你可以放在第一行,也可以最后一行。有两个参数,第一个是需要注册的路由,第二个是支持的方法。

路由可以支持beego支持的任意规则,例如/object/:key这样的参数路由,也可以固定路由/object,也可以是正则路由/cms_:id([0-9]+).html

支持的HTTP方法必须使用[]中间是支持的方法列表,多个使用,分割,例如[post,get]。但是目前自动化文档只支持一个方法,也就是你多个的方法的时候无法做到RESTFul到同一个函数,也不鼓励你这样设计的API。如果你API设计的时候支持了多个方法,那么文档生成的时候默认是取第一个作为支持的方法。

上面我们看到我们的方法上面有很多注释,那么接下来就进入我们今天的重点:自动化文档

自动化文档

所谓的自动化文档,说白了就是根据我们的注释自动的生成我们可以看得懂的漂亮文档。我们上面也说了写注释不仅仅是方便我们的代码维护,逻辑阐述,同时如果能够自动生成文档,那么对于使用API的用户来说也是很大的帮助。那么如何进行自动化文档生成呢?

我当初看了swagger的展示效果之后,首先研究了他的spec,发现是一些json数据,只要我们的API能够生成swagger认识的json就可以了,因此我的思路就来了,根据注释生成swagger的JSON标准数据输出。swagger提供了一个例子代码:petstore 我就是根据这个例子的格式一步一步实现了现在的自动化文档。

首先第一步就是API的描述:

API文档

我们看到在router.go里面头部有一大段的注释,这些注释就是描述整个项目的一些信息:

// @APIVersion 1.0.0
// @Title beego Test API
// @Description beego has a very cool tools to autogenerate documents for your API
// @Contact astaxie@gmail.com
// @TermsOfServiceUrl http://beego.me/
// @License Apache 2.0
// @LicenseUrl http://www.apache.org/licenses/LICENSE-2.0.html

这里面主要是几个标志:

  • @APIVersion

  • @Title

  • @Description

  • @Contact

  • @TermsOfServiceUrl

  • @License

  • @LicenseUrl

这里每一个都不是必须的,你可以写也可以不写,后面就是一个字符串,你可以使用任意喜欢的字符进行描述。我们来看一下生成的:http://127.0.0.1:8080/docs

{
  "apiVersion": "1.0.0",
  "swaggerVersion": "1.2",
  "apis": [
    {
      "path": "/object",
      "description": "Operations about object\n"
    },
    {
      "path": "/user",
      "description": "Operations about Users\n"
    }
  ],
  "info": {
    "title": "beego Test API",
    "description": "beego has a very cool tools to autogenerate documents for your API",
    "contact": "astaxie@gmail.com",
    "termsOfServiceUrl": "http://beego.me/",
    "license": "Url http://www.apache.org/licenses/LICENSE-2.0.html"
  }
}

这是首次请求的一些信息,那么apis是怎么来的呢?这个就是根据你的namespace进行源码AST分析获取的,所以目前只支持两层的namespace嵌套,而且必须是两层,第一层是baseurl,第二层就是嵌套的namespace的prefix。也就是上面的path信息,那么里面的description那里获取的呢?请看控制器的注释,

控制器注释文档

针对每一个控制我们可以增加注释,用来描述该控制器的作用:

// Operations about object
type ObjectController struct {
    beego.Controller
}

这个注释就是用来表示我们的每一个控制器API的作用,而控制器的函数里面的注释就是用来表示调用的路由、参数、作用以及返回的信息。

// @Title Get
// @Description find object by objectid
// @Param   objectId        path    string  true        "the objectid you want to get"
// @Success 200 {object} models.Object
// @Failure 403 :objectId is empty
// @router /:objectId [get]
func (this *ObjectController) Get() {
}

从上面的注释我们可以把我们的注释分为以下类别:

  • @Title

    接口的标题,用来标示唯一性,唯一,可选

    格式:之后跟一个描述字符串

  • @Description

    接口的作用,用来描述接口的用途,唯一,可选

    格式:之后跟一个描述字符串

  • @Param

    请求的参数,用来描述接受的参数,多个,可选

    格式:变量名 传输类型 类型 是否必须 描述

    传输类型:

    类型:

    变量名和描述是一个字符串

    是否必须:true 或者false

    • string

    • int

    • int64

    • 对象,这个地方大家写的时候需要注意,需要是相对于当前项目的路径.对象,例如models.Object表示models目录下的Object对象,这样bee在生成文档的时候会去扫描改对象并显示给用户改对象。

    • query 表示带在url串里面?aa=bb&cc=dd

    • form 表示使用表单递交数据

    • path 表示URL串中得字符,例如/user/{uid} 那么uid就是一个path类型的参数

    • body 表示使用raw body进行数据的传输

    • header 表示通过header进行数据的传输

    • @Success

      成功返回的code和对象或者信息

      格式:code 对象类型 信息或者对象路径

      code:表示HTTP的标准status code,200 201等

      对象类型:{object}表示对象,其他默认都认为是字符类型,会显示第三个参数给用户,如果是{object}类型,那么就会去扫描改对象,并显示给用户

      对象路径和上面Param中得对象类型一样,使用路径.对象的方式来描述

    • @Failure

      错误返回的信息,

      格式: code 信息

      code:同上Success

      错误信息:字符串描述信息

    • @router

      上面已经描述过支持两个参数,第一个是路由,第二个表示支持的HTTP方法

    那么我们通过上面的注释会生成怎么样的JSON信息呢?

    {
      "path": "/object/{objectId}",
      "description": "",
      "operations": [
        {
          "httpMethod": "GET",
          "nickname": "Get",
          "type": "",
          "summary": "find object by objectid",
          "parameters": [
            {
              "paramType": "path",
              "name": "objectId",
              "description": "\"the objectid you want to get\"",
              "dataType": "string",
              "type": "",
              "format": "",
              "allowMultiple": false,
              "required": true,
              "minimum": 0,
              "maximum": 0
            }
          ],
          "responseMessages": [
            {
              "code": 200,
              "message": "models.Object",
              "responseModel": "Object"
            },
            {
              "code": 403,
              "message": ":objectId is empty",
              "responseModel": ""
            }
          ]
        }
      ]
    }

    上面阐述的这些描述都是可以使用一个或者多个 '\t', '\n', '\v', '\f', '\r', ' ', U+0085 (NEL), U+00A0 (NBSP)进行分割

    对象自定义注释

    我们的对象定义如下:

    type Object struct {
        ObjectId   string
        Score      int64
        PlayerName string
    }

    通过扫描生成的代码如下:

    Object {
    ObjectId (string, optional): ,
    PlayerName (string, optional): ,
    Score (int64, optional):
    }

    我们发现字段都是optional的,而且没有任何针对字段的描述,其实我们可以在对象定义里面增加如下的tag:

    type Object struct {
        ObjectId   string   `required:"true" description:"object id"`
        Score      int64        `required:"true" description:"players's scores"`
        PlayerName string   `required:"true" description:"plaers name, used in system"`
    }

    而且如果你的对象tag里面如果存在json或者thrift描述,那么就会使用改描述作为字段名,即如下的代码:

    type Object struct {
        ObjectId   string   `json:"object_id"`
        Score      int64        `json:"player_score"`
        PlayerName string   `json:"player_name"`
    }

    就会输出如下的文档信息:

    Object {
    object_id (string, optional): ,
    player_score (string, optional): ,
    player_name (int64, optional):
    }

    常见错误及问题

    1. Q:bee没有上面执行的命令?

      A:请更新bee到最新版本,目前bee的版本是1.1.2,beego的版本是1.3.1

    2. Q:bee更新的时候出错了?

      A:第一可能是GFW的问题,第二可能是你修改过了源码,删除重新下载,第三可能你升级了Go版本,你需要删除GOPATH/pkg下的所有文件

    3. Q:下载swagger很慢?

      A:想办法让他变快,因为我现在放在了github上面

    4. Q:文档生成了,但是我没办法测试请求?

      A:你看看你访问的地址是不是和请求的URL是同一个地址,因为swagger是使用Ajax请求数据的,所以跨域的问题,解决CORS的办法就是保持域一致,包括URL和端口。

    5. Q:运行的时候发生了未知的错误?

      A:那就来提issue或者给我留言吧,我会尽力帮助你解决你遇到的问题


    展开阅读全文
    打赏
    32
    127 收藏
    分享
    加载中
    这个swagger版本是不是低了,我能说好丑吗????
    08/04 11:30
    回复
    举报
    对象自定义注释
    我们的对象定义如下:

    type Object struct {
      Code int
      Info string
    }
    通过扫描生成的代码如下:

    Object {
    Code: integer ($int32)
    Info:   string
    }
    我这个是基于beego开发文档:https://beego.me/docs/advantage/docs.md 来写的,想要给对象加自定义注解,通过上面的方式也弄不出来,不知道作者有遇到过么
    02/21 10:47
    回复
    举报
    beego 用的swagger 版本好像有点旧了吧能不能升级一下
    2017/05/09 23:34
    回复
    举报
    -gendoc=true 这个地方坑死我了,耽误了好长时间啊
    2017/03/14 13:50
    回复
    举报
    为什么我按步骤操作完了,浏览地址 报:404错误 提示
    Not Found
    The page you have requested has flown the coop.
    Perhaps you are here because:


    The page has moved
    The page no longer exists
    You were looking for your puppy and got lost
    You like 404 pages
    2016/12/08 09:06
    回复
    举报
    貌似发现一处错误 -docgen=true 应该是 -gendoc=true 吧32
    2016/04/13 14:12
    回复
    举报
    很赞,已尝试。
    2014/08/06 16:42
    回复
    举报
    2014/06/27 15:52
    回复
    举报
    一定要玩玩
    2014/06/27 00:07
    回复
    举报
    2014/06/26 22:57
    回复
    举报
    更多评论
    打赏
    22 评论
    127 收藏
    32
    分享
    在线直播报名
    返回顶部
    顶部