我可以根据 openapi 3.0 规范将占位符或对枚举列表的引用添加到模式描述中吗?
Can I add placeholder or reference to enum list into schema description according to openapi 3.0 specs?
需要使用同一 openapi.yaml 文件中定义的枚举列表来更新架构描述。这是 伪代码 中的示例和理想的结果:
enum:
- John
- Doe
description: {enumList} is the name
结果
John Doe is the name
问题是这种方法是否可行。 Schema 描述支持 markdown 语法,但我找不到实现这种结果的机制
编辑:理论上它可以是一个字符串数组
OpenAPI 规范和 Markdown 都不支持开箱即用的模板化描述。但是您可以编写一个脚本来解析 OpenAPI 文件,并将您的自定义模板语法替换为所需的值。有OpenAPI parsers for different programming languages, or you could use a YAML/JSON processor such as yq.
需要使用同一 openapi.yaml 文件中定义的枚举列表来更新架构描述。这是 伪代码 中的示例和理想的结果:
enum:
- John
- Doe
description: {enumList} is the name
结果
John Doe is the name
问题是这种方法是否可行。 Schema 描述支持 markdown 语法,但我找不到实现这种结果的机制
编辑:理论上它可以是一个字符串数组
OpenAPI 规范和 Markdown 都不支持开箱即用的模板化描述。但是您可以编写一个脚本来解析 OpenAPI 文件,并将您的自定义模板语法替换为所需的值。有OpenAPI parsers for different programming languages, or you could use a YAML/JSON processor such as yq.