在 Swagger UI 中屏蔽输入（示例 - 密码）？

Question

我有一个 API 的三个路径变量。我想用 ***** 屏蔽 Swagger UI 上的一个输入。

使用 Springdoc OpenAPI 时如何做到这一点？

Answer 1

您只需使用 swagger 注释即可：

@Parameter(schema = @Schema(type = "string", format = "password")) 

Answer 2

如 jenkinsme 在他们的答案中所示，将 format 设置为

password

。此外，不需要 type 字段，因为它默认为字符串（希望所有密码都是字符串）。

@Parameter(schema = @Schema(format = "password"))

上面会出现如下图所示

请参阅 OpenAPI 规范页面上的数据类型，了解所有支持的类型

Answer 3

使用 YAML 从 OpenAPI 3 文档生成代码：

components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: string
          format: uuid
        username:
          type: string
        password:
          type: string
          format: password
        givenName:
          type: string
        familyName:
          type: string
        address:
          type: string
      required:
        - id
        - username
        - password
        - givenName
        - familyName
        - address

请注意，

type: string

对于密码来说不是必需的，因为

format: password

已经暗示了它，但我喜欢保持不变。