Swagger 如何将可能值的列表添加到一个招摇过市的文档中?
假设我有以下路线:Swagger 如何将可能值的列表添加到一个招摇过市的文档中?,swagger,swagger-editor,Swagger,Swagger Editor,假设我有以下路线: paths: /data: get: summary: Get list of securities based on filter parameters: - name: market in: query description: Filter securities by market id, default ```all``` type: string
paths:
/data:
get:
summary: Get list of securities based on filter
parameters:
- name: market
in: query
description: Filter securities by market id, default ```all```
type: string
default: all
我如何才能添加一个可以使用的值列表
这是否得到支持?我看到一个
enum
字段,但添加到任何参数时都会出现错误。enum
就是这样。您可以在enum
下为参数和属性指定值列表。以下是一个例子:
---
swagger: '2.0'
info:
version: 0.0.0
title: Simple API
paths:
/data:
get:
summary: Get list of securities based on filter
parameters:
- name: market
in: query
description: Filter securities by market id, default ```all```
type: string
default: all
enum:
- all
- market1
- market2
responses:
200:
description: OK
您可以将上面的内容复制并粘贴到swagger editor以查看输出。当然,当其他人发布它时它会起作用=/btw,我想当我执行enum时,它应该显示在UI上?是的,swagger editor和swagger UI都支持
enum
,并且这些工具中会显示值列表。