将自定义baucis路由添加到其生成的swagger api中

时间:2013-12-06 03:26:22

标签: rest express middleware swagger baucis

当我们创建应用时,我们通常会添加自己的路线。 所以使用baucis.rest我添加了一些自定义路由,例如:

var controller = baucis.rest( {
     singular: 'User'
} );
controller.put('/myroute/:id', function(req,res,done){
    //doing something
})

我的应用程序运行并使用swagger ui我可以看到有关用户的操作。

GET   /Users/{id}                  description
PUT   /Users/{id}                  description 
......

我想将“/ myroute /:id”添加到生成的swagger api中。

PUT   /Users/myroute/{id}          description

有谁知道怎么办?

1 个答案:

答案 0 :(得分:1)

从v0.9.0开始,您可以直接修改swagger定义。它纯粹是装饰性的,只是改变了招摇文档,而不是任何其他功能。

例如:

var controller = baucis.rest('User');
controller.swagger.apis.push({
  'path': '/Users/myroute/{id}',
  'description': 'Myroute custom description.',
  'operations': [
    {
      'httpMethod': 'PUT',
      'nickname': 'putSomethingCustom',
      'responseClass': 'User',
      'summary': 'Something custom.'
    }
  ]
})

controller.swagger.models也曝光了。