Swagger/OpenAPI - use $ref to pass a reusable defined parameter

后端 未结 2 1553
闹比i
闹比i 2020-12-01 02:42

Let\'s say I\'ve got a parameter like limit. This one gets used all over the place and it\'s a pain to have to change it everywhere if I need to update it:

2条回答
  •  天命终不由人
    2020-12-01 02:55

    For completeness, here's how it would look like in OpenAPI (a.k.a swagger v3):

    openapi: "3.0.0"
    servers:
        - url: /v1
          description: local server
    
    paths:
       /path:
          get:
             parameters:
                - $ref: "#/components/parameters/limitParam"
    
    components:
       parameters:
          limitParam:
             name: limit
             in: query
             description: Limits the number of returned results
             required: false
             schema:
                type: integer
                minimum: 10
                default: 10
                multipleOf: 10 # matches 10, 20, ...
                format: int32
    

提交回复
热议问题