Swagger:Issue with Path parameter

前端 未结 1 1353
日久生厌
日久生厌 2020-12-15 15:17

I am try to create a swagger file with the following path: paths: /v1/customers/{id}/summary :

However I get the following error right off bat:

AP

相关标签:
1条回答
  • 2020-12-15 15:58

    Basically, you're declaring a path that has a path parameter in it, by using path templates. In this case {id} declares a path parameter called id.

    When you declare such a path, it means that you have to declare that path parameter as part of the operation.

    Take a look at this YAML example:

      /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'
    

    You can see there's an {id} in the path, and a corresponding id parameter definition. Without it, the spec won't be valid.

    0 讨论(0)
提交回复
热议问题