swagger-egg icon indicating copy to clipboard operation
swagger-egg copied to clipboard

注意:关于如何定义示例(example)的问题

Open JsonMa opened this issue 3 years ago • 2 comments

注意:parameter(仅当类型为body时)及response中可以通过schema的example字段来定义示例!

例如:

image

JsonMa avatar Mar 13 '22 15:03 JsonMa

parameters 参数类型为 formdata,query,path等,不想去建一个schema约束文件,是否能支持在controller文件中的@description #parameters直接定义一个示例值。

aixinyongheng avatar Mar 16 '22 06:03 aixinyongheng

parameters 参数类型为 formdata,query,path等,不想去建一个schema约束文件,是否能支持在controller文件中的@description #parameters直接定义一个示例值。

swagger里面只有schema才能写example,如果通过@description去描述的话,首选要关联指定的schema,另外注释的体积也会很大。如果确实要给parameter id这种在请求路径中的参数加上示例,建议可以在 "-" 后的描述字段中直接写。

JsonMa avatar Mar 16 '22 07:03 JsonMa