【问题标题】:parameter and response not working in swagger ui in nodejs参数和响应在nodejs的swagger ui中不起作用
【发布时间】:2022-08-24 11:33:45
【问题描述】:

这个书面的 cmets 不适合我它没有在 UI 中显示参数和响应。

// Routes
/**
* @swagger
* /test:
*      get:
*           description: Returns all users
*      parameters:
*               - name: customer
*                 in: query
*                 description: Model name
*                 required: true
*                 schema:
*                   type: string
*                   format: string
*      responses:
*          \'200\':
*               description: Successfully returned paginated records
*          \'403\':
*               description: Not enough permissions read_modelName
*/
  • 缩进似乎是错误的,也是“参数”?!
  • 好的参数在这里是错字。但我没有得到正确的缩进你能展示一些缩进格式/例子吗?我应该在获取中使用“响应”吗?或外面像上面?

标签: node.js express swagger swagger-ui swagger-2.0


【解决方案1】:

您应该将每个新行缩进两个空格。如果您不进行相应的缩进,swagger UI 将无法正确呈现。有关示例,请参阅此文档:https://swagger.io/docs/specification/adding-examples/

您可能还想安装一个 yaml 格式化程序来帮助格式化 Swagger,但如果您选择不使用它,请确保注意间距,因为这是您当前的问题。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2021-03-28
    • 2021-03-29
    • 2019-12-06
    • 2013-12-07
    • 1970-01-01
    相关资源
    最近更新 更多