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

OpenAPI中的变量查询参数名

江凯风
2023-03-14
/search:
    get:
      parameters:
        - in: query
          name: facet
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - key1 # Description?
                - key2
        - in: query
          name: {facet_name}
          required: false
          ???

这是唯一的解决办法吗:

/search:
    get:
      parameters:
        - in: query
          name: facet
          required: false
          schema:
            type: array
            items:
              type: string
              enum:
                - key1 # Description ?
                - key2
        - in: query
          name: key1
          required: false
          schema:
            type: string
          description: Key1 is that...

共有1个答案

易刚捷
2023-03-14

枚举中的所有值都必须符合指定的类型。如果需要指定枚举项的说明,可以在参数或属性的说明中进行,

Description支持格式文本表示的Markdown CommonMark,如下例所示:

description: >
  **Your Title**:
    * `key1` - description for key1
    * `key2` - description for key2

它看起来:

 类似资料:
  • 我正在编写一个Fast API服务器,它接受请求,检查用户是否被授权,如果成功,则将其重定向到另一个URL。 我需要携带URL参数,例如

  • 我正在开发一个API,它允许使用URL进行搜索,比如: 这个答案几乎是我想要做的,我只是找不到一种方法来定义括号内的值为“任何字符串”,而不是已知名称的列表。

  • 我有一个这样的endpoint: 在这里,是向用户公布的关键字。但是和是任意参数。对于另一个资源,如,任意参数可以是。 在 openapi 规范中,我有 我正在使用代码生成插件 ,在服务器控制器中,我想捕获所有任意参数。如何扩展我的 openapi 规范以使参数超出。如果有一种方法可以在单个数组中获取所有查询参数,那也将有所帮助。

  • 假设我有一个URL,其路径为: 如何将其转换为大摇大摆的文档,具体地说,将对象数组和数组作为查询参数。

  • 有什么方法可以记录下面的查询吗? 其中查询参数名称是动态的,将从客户端接收。 我正在使用最新的Swagger API。