如何在 Swagger Doc 模型中显示所有字符串示例

Question

我的模型中的一个大摇大摆 returns 'Status' 属性可能是多个字符串之一。

例如：

"Status" : {
    "type":"string",
    "example" : "'Completed' || 'Group Completed' || 'Errored' || 'Group Errored' || 'Ready' || 'Stopped By User' ||  'Initializing' || 'Queued' || 'Group Queued' ||  'Running' || 'Group Running' ||  'Stopping' || 'Group Stopping'"
               },

这样做看起来真的很乱。向用户显示所有这些可能结果的最佳方式是什么？

Answer 1

为此属性定义 enum:

"Status" : {
  "type": "string",
  "enum": [
    "Completed",
    "Group Completed",
    "Errored",
    ...
  ]
}

文档呈现器将显示架构文档中的所有枚举值。

如何在 Swagger Doc 模型中显示所有字符串示例

How to show all string examples in Swagger Doc model

swagger-ui