Swagger 2.0如何硬编码address/username属性值（不使用default）

问题描述 #

我有如下Swagger 2.0的路径和TestEntity定义配置：

/test:
    post:
      consumes:
        - "application/json"
      parameters:
        - in: "body"
          name: "TestEntity"
          schema:
            $ref: "#/definitions/TestEntity"
      produces:
        - "application/json"
      responses:
        200:
          description: "200 response"
          schema:
            $ref: "#/definitions/TestEntity"
  /user/login:
    get:
      produces:
      - "application/json"
      parameters:
      - name: "username"
        in: "query"
        default: 'John Smith'
        required: true
        type: "string"


definitions:
 TestEntity:
    properties:
      address:
        type: string
        default: '1 street'
    required:
      - address

请问能不能不使用default选项，给address和username属性显式硬编码值？也就是用户不用手动指定，由Swagger自动设置这个值。

解决方法 #

Swagger 2.0规范本身没有原生替代default的字段来实现自动填充硬编码值的需求，你可以通过以下两种方式实现目标：

后端硬编码补值

这是最可靠的方式，直接在后端接口逻辑里固定赋值：

• 对于/user/login的username参数：把Swagger配置里的required改成false，后端收到请求后，若该参数未传入，直接赋值为John Smith；如果需要强制使用硬编码值，甚至可以忽略用户传入的参数，直接用固定值。
• 对于TestEntity的address字段：后端接收请求体后，自动给address填充1 street，不管用户是否传入该值。

自定义Swagger UI前端逻辑

如果需要在Swagger UI界面上自动显示填充好的值，需要修改Swagger UI的前端代码：

• 针对查询参数username：在页面加载完成后，定位到该参数的输入框，直接设置其值为John Smith。
• 针对请求体中的address：在Swagger UI的请求体编辑器初始化时，自动给address字段填充1 street。

注意：前端自定义逻辑可能被用户手动修改，无法保证最终传入后端的值是硬编码值，因此更推荐后端硬编码的方式。

内容的提问来源于stack exchange，提问作者John Smith