baucis swagger文档的自定义响应和参数

时间:2014-10-27 09:05:09

标签: baucis

我发现在baucis中为自定义端点的swagger UI添加文档相对容易。

 var controller = baucis.rest('User');
 controller.swagger.apis.push({
   'path': '/users/login',
   'description': 'Logs a user in',
   'operations': [
     {
       'httpMethod': 'POST',
       'nickname': 'Login',
       'responseClass': 'User',
       'summary': 'Requests auth token given username and password'
     }]})

但是,在上面这种情况下,我想将响应类设置为{token:string}而不是'User',并将参数设置为{username:string,password:string},以便'尝试'出来!'按钮工作。

有什么想法我会怎么做?或者,如果有可能在baucis-swagger?

1 个答案:

答案 0 :(得分:2)

似乎上面的baucis对象就在swagger specification之后。

将参数定义对象数组和响应定义对象数组添加到上面的对象可以解决我的问题。