当前位置: 首页 > 知识库问答 >
问题:

不是Swagger查询的有效参数定义?

党祖鹤
2023-03-14
# GET verb version of the "GetClientsForGadget" method from the original ASMX Service
  /clients/ProspectClient/roleandcstbased/{OrgNmFilter}/{SortNm}?{UserName}:
    get: 
      tags:
        - Client
      summary: Merging of GetClientsforGadget and GetClientsForUser
      operationId: ClientsForGadgetGET
      parameters:
        - name: OrgNmFilter
          in: path
          description: Organization Name Filter
          required: true
          type: string
        - name: SortNm
          in: path
          description: Sort Field
          required: true
          type: string
        - name: UserName
          in: query
          description: User's Identity
          required: false
          type: string
      responses:
        200: 
          description: Output results for GetClientsForGadget endpoint
          schema: 
            $ref: '#/definitions/ClientOutput'

Swagger没有为这个查询参数提供有效的参数定义。如果我删除路径和参数定义中对用户名的所有引用,则不会出现任何问题。

根据Swagger规范,我相信我使用了正确的查询参数,但不知何故它不是。

共有1个答案

花稳
2023-03-14

意识到问题出在路径上。路径不需要包含查询参数。

/clients/ProspectClient/roleandcstbased/{OrgNmFilter}/{SortNm}?{UserName}:

/clients/ProspectClient/roleandcstbased/{OrgNmFilter}/{SortNm}:

它只需要在参数中定义查询。否则会把整个事情搞糟。

 类似资料:
  • 这是我的输入: 它说: 详细资料 我到底做错了什么?

  • 我正在尝试为rest api定义一个简单的swagger定义。我在所有参数部分都收到错误。 我在招摇编辑器中得到了以下招摇定义错误,我不知道我错了什么。请告知。 昂首阔步的定义: 昂首阔步错误:

  • 在我的Zend应用程序中,我正在为移动应用程序编写一个小API。为了方便移动开发者,我使用了Swagger。到目前为止,除了一个GET请求外,一切正常。 当我呼叫/user/messages/{sessionToken}时?numMessages={numMessages} 有人知道我的错误吗? 欢迎任何帮助。 诚挚的问候 罗特曼 更新:按照建议,我将两个参数类型都更改为“查询”并更改了路径: 但

  • 我面临的问题与我的招摇文件: 这是我的问题: ✖Swagger Error非有效参数定义跳转到第20行详细信息目标代码:ONE_OF_MISSING参数:数组[0]消息:非有效参数定义路径:数组[5] 0:路径1:/货币/{当前ID} 2:获取3:参数4:0模式ID:http://swagger.io/v2/schema.json#内部:数组[2]级别:900类型:Swagger Error描述:

  • 我有这个夸张的定义 但它给我以下错误 ✖ Swagger Error Not a valid parameter definition跳转到第6996行Details Object code:“ONE\u OF_MISSING”参数:数组[0]消息:“Not a valid parameter definition”路径:数组[5]schemaId:http://swagger.io/v2/sch

  • 我在django中有一个api(Web服务),如下所示:http://127.0.0.1:9000/api/back_office/appointments/days/?branch=1,在swagger中,我想输入名为分支的查询参数,但不起作用(我所有的api都有同样的问题!!)。 以前,我使用旧版本的swagger,对于输入查询参数使用like - param_name语法,但是现在在djan