对于某些操作,我们的API使用JSON的静态位进行响应,例如:
{"status":"ok"}
我最接近为此制作模型定义是:
definitions:
OKMessage:
type: object
properties:
status:
type: string
enum: ['ok']
但感觉应该有一种更直接的方式来表示模型中的静态字符串(并产生更清晰的文档)。我缺少规范中的某些内容吗?
答案 0 :(得分:1)
我认为这是定义响应的正确方法。您可以考虑使用字符串(不是枚举)来为您提供在将来添加不同值(例如错误,处理等)的灵活性。