Yaml apariy编辑器上的Swagger将默认值0呈现为null
我正在使用Swagger YAML文件在apariy.io上生成交互式文档 我注意到一个奇怪的问题,如果我为一个整数指定一个默认值0,那么交互文档根本不会呈现它,而是显示null作为默认值。如果我指定一个非零值,它的渲染效果会非常好 例如:Yaml apariy编辑器上的Swagger将默认值0呈现为null,yaml,swagger-2.0,apiary.io,Yaml,Swagger 2.0,Apiary.io,我正在使用Swagger YAML文件在apariy.io上生成交互式文档 我注意到一个奇怪的问题,如果我为一个整数指定一个默认值0,那么交互文档根本不会呈现它,而是显示null作为默认值。如果我指定一个非零值,它的渲染效果会非常好 例如: - name: pageNumber in: query description: The page number, starting at 0. required: true type: number format:
- name: pageNumber
in: query
description: The page number, starting at 0.
required: true
type: number
format: int32
default: 0
- name: pageSize
in: query
description: The page size (max number of entities that are displayed in the
response).
required: true
type: integer
format: int32
default: 20
将?pageNumber=&pageSize=20追加到我的路径,而它应该添加?pageNumber=0&pageSize=20
当我添加一个非零时,如下所示:
- name: pageNumber
in: query
description: The page number, starting at 0.
required: true
type: number
format: int32
default: 1
- name: pageSize
in: query
description: The page size (max number of entities that are displayed in the
response).
required: true
type: integer
format: int32
default: 20
这被渲染得很好,并按预期添加了?pageNumber=1和pageSize=20。海伦的评论解决了我的问题。 在apariy.io上使用YAML编制文档时,为了在交互式文档中设置默认值/初始值,需要使用x-example。现在,以下工作按预期进行:
- name: pageNumber
in: query
description: The page number, starting at 0.
required: true
type: number
format: int32
x-example: 0
- name: pageSize
in: query
description: The page size (max number of entities that are displayed in the
response).
required: true
type: integer
format: int32
x-example: 20
已成功渲染为?pageNumber=0&pageSize=20FYI:。要提供一个示例值以避免与默认值混淆,请改用x-example。