Swagger 忽略了招摇过市模式属性-为什么?
我试图构建一个简单的招摇模型:Swagger 忽略了招摇过市模式属性-为什么?,swagger,openapi,swagger-2.0,redoc,Swagger,Openapi,Swagger 2.0,Redoc,我试图构建一个简单的招摇模型: PlayerConfig: type: object required: - kind - player_id properties: kind: type: string example: PlayerConfig player_id: type: string example: "foo" description: "bar&q
PlayerConfig:
type: object
required:
- kind
- player_id
properties:
kind:
type: string
example: PlayerConfig
player_id:
type: string
example: "foo"
description: "bar"
sports_config:
oneOf:
- $ref: '#/components/schemas/PlayerConfig'
discriminator:
propertyName: kind
由于某些原因,生成的HTML没有显示玩家id
的示例
字段。这让我觉得我做得不对
所以问题是,使用一个模型作为一个类型是否真的可以像我尝试的那样<代码>示例如果其父字段是参数:
而不是属性:
,则会呈现该字段
更新:我阅读了上的对象和属性示例
部分,似乎我的代码片段应该可以工作
更新#2:我实际上下载了redoc cli
(这是OpenAPI->html捆绑包的cli工具),并从Swagger编辑器中获取了一个样本规范,该规范在属性下有示例
字段,它模仿了我的问题,看起来是预期的(请参阅我附加的屏幕截图):
如果字符串值包含空格(或其他特殊字符),则应将其括在引号中。所以这行应该是
example: "LeBron James"
谢谢你的建议!“已经试过了,不幸的是仍然没有成功。@阿列克谢万诺夫也许下一行中的单引号有问题?您是否尝试将描述用引号括起来?更新了问题。您使用的是什么文档工具?您所说的文档工具是什么意思?更新:我使用的是ReDoc: