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

Question

当我们创建应用程序时，我们通常会添加自己的路线。 所以使用 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

有谁知道该怎么做？

Answer 1

从 v0.9.0 开始，您可以直接修改 swagger 定义。它纯粹是装饰性的，只是改变了 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 也暴露了。