【问题标题】:Custom response and parameters for baucis swagger docsbaucis swagger 文档的自定义响应和参数
【发布时间】:2014-10-29 00:01:09
【问题描述】:

我发现在 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},以便 'Try出来!'按钮有效。

任何想法我会怎么做?或者如果有可能在 baucis-swagger 中?

【问题讨论】:

    标签: baucis


    【解决方案1】:

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

    向上面的对象添加参数定义对象数组和响应定义对象数组解决了我的问题。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2017-01-19
      • 2021-12-07
      • 2023-03-21
      相关资源
      最近更新 更多