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

swagger:使用路径参数发出

宋经业
2023-03-14

如果我对此进行深入研究,我会看到以下内容:

Details
 Object
 swaggerError: Object
 errors: Array [1]
 0: Object
code:  "MISSING_API_PATH_PARAMETER"
message:  "API requires path parameter but it is not defined: id"
data:  "/v1/customers/{id}/summary"
 path: Array [2]
 warnings: Array [0]

共有1个答案

梁丘柏
2023-03-14

基本上,您是通过使用路径模板声明一个包含路径参数的路径。在本例中,{id}声明一个名为id的路径参数。

当您声明这样一个路径时,意味着您必须声明该路径参数作为操作的一部分。

看一下这个YAML示例:

  /pets/{id}:
    get:
      description: Returns a user based on a single ID, if the user does not have access to the pet
      operationId: findPetById
      produces:
        - application/json
        - application/xml
        - text/xml
        - text/html
      parameters:
        - name: id
          in: path
          description: ID of pet to fetch
          required: true
          type: integer
          format: int64
      responses:
        '200':
          description: pet response
          schema:
            $ref: '#/definitions/pet'
        default:
          description: unexpected error
          schema:
            $ref: '#/definitions/errorModel'
 类似资料:
  • 问题内容: 我想用可选的path参数声明一个路径,因此当我添加它时,页面会做一些额外的事情(例如,填充一些数据): http:// localhost / app / path / to / page <=渲染页面 http:// localhost / app / path / to / page / pathParam <=根据pathParam使用某些数据渲染页面 在我的React Rout

  • 我正在尝试从文件中添加路由,但我事先不知道实际参数,因此我需要有一个通过处理参数的通用函数。 要添加路线,我使用,如下所示: 以上工作正常。 但是enrty path参数不是固定的,我需要从文件中读取它们,为了实现这一点,我正在尝试这样的事情: 但它抛出此错误: FastAPI尝试在<code>foo</code>签名中查找不存在的实际参数<code>xyz</code>。 FastAPI中有什么

  • 将路由链接到参数 显示特定产品详细信息的组件的路由需要该产品ID的路由参数。我们可以使用以下实现: 注意:product-details路由的路径中的 ,它将参数放在路径中。例如,要查看ID为5的产品的产品详细信息页面,必须使用以下URL:localhost:3000/product-details/5 注意,指令传递一个数组,该数组指定路径和路由参数。或者,我们可以使用JS跳转: Product

  • 我正在开发一个具有这种结构的rest Web服务 http://localhost:8080/context/login/{用户}/{密码} 此请求的示例为 http://localhost:8080/context/login/admin/admin 我在applicationContext中配置了一个AbstractPhaseInterceptor。我的spring应用程序的xml。拦截器类是

  • 我有一个API,它允许传入任何任意路径,例如所有这些: 是有效路径。我试着这样描述: 但是https://generator.swagger.io在路径中编码斜线,所以不起作用。那么有没有办法用Swagger来描述我的API呢?

  • Swagger用相同的路径和方法但不同的参数覆盖方法 我有一个带有Spring Boot 2.3.5.RELEASE,webflux和springfox 3.0.0的应用程序。我开发了两个具有相同路径但参数不同的GET方法,一个不接收参数并返回list,另一个返回findAll。 情况是,Swagger只生成其中一种方法的文档,有时是列表,有时是分页。我怎么能告诉swagger他们是不同的方法,并