小编Hed*_*shy的帖子

如何使用swagger在路径中定义可选参数

我的REST Web服务中有一个使用GET方法的函数,它有两个可选参数.

我尝试在Swagger中定义它但在设置as 后遇到错误,不是有效的参数定义.requiredfalse

我发现如果我设置required值,因为true错误将消失.这是我的Swagger代码示例.

...
paths:
  '/get/{param1}/{param2}':
    get:
      ...
      parameters:
      - name: param1
        in: path
        description: 'description regarding param1'
        required: false
        type: string
      - name: param2
        in: path
        description: 'description regarding param2'
        required: false
        type: string
Run Code Online (Sandbox Code Playgroud)

我没有使用body中的参数或查询中的参数来体验这一点.我认为这个问题只与路径中的参数有关.我也无法在swagger规范文件中找到任何解决方案.

有没有其他方法可以在Swagger中定义可选参数,或者我的代码中是否有任何错误?

任何帮助,将不胜感激.

rest web-services swagger

46
推荐指数
4
解决办法
5万
查看次数

标签 统计

rest ×1

swagger ×1

web-services ×1