如何将 Swagger UI 的参数设置为下拉菜单,而不是文本输入

2022-09-02 13:01:52

我正在使用swagger来显示我的RESTApi,API的一个参数将字符串作为输入并将其转换为枚举值。有没有办法在 Swagger UI 上显示下拉菜单,而不是文本输入字段,以便用户只能选择枚举值中的字符串值。


答案 1

您可以使用以下 swog 代码显示下拉列表。您必须使用枚举。例如,如果您想将性别作为输入,那么可以有三个可能的值

  • 男, 女, 其他
-name: "gender"
          in: "query"
          type: "string"
          enum: [ "male", "female", "other"]
          description: "Enter user gender here."
          required: true

答案 2

关键是在注释中使用允许值。@ApiParam

演示显示结果:

http://petstore.swagger.io/#!/pet/findPetsByStatus

签出,它不是一个下拉列表,但在多选框中输入受到限制。pet/findByStatus