我正在尝试构建一个简单的 Swagger 模型:
resources:
- kind: PlayersDB
api_version: players/v2
path: players
attributes:
...
status:
- name: status
type: string
x-extensible-enum: [HEALTHY, INJURED]
...
example: HEALTHY
required: true
filters:
- type: SearchFilter
strategy: exact
include_on:
- list
由于某种原因,生成的 HTML 不会在查询参数下呈现状态过滤器。这让我觉得我做得不对。
也就是说,当我将架构编辑为:
resources:
- kind: PlayersDB
api_version: players/v2
path: players
attributes:
...
status:
- name: status
type: string
x-extensible-enum: [HEALTHY, INJURED]
...
example: HEALTHY
required: true
filters:
- property: status
type: SearchFilter
field: status
strategy: exact
example: HEALTHY
include_on:
- list
过滤器被渲染。
一些上下文:对于 spec.yaml -> html,我使用的是 redoc-cli
(这是一个用于 OpenAPI -> html 包的 CLI 工具)。
问题是可以渲染 #1 还是 OpenAPI 格式不支持?
我确实阅读了关于 https://swagger.io/docs/specification/adding-examples/ 的 Object and Property Examples
部分,但没有找到很多与过滤器相关的信息。