如何在swagger codegen中处理多种响应/返回类型(204为空,400为非空等)?
我使用的是Openapi 3.0.2版。
我有以下规范来描述我的响应:
responses:
'201':
description:
Created
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: The resource could not be found.
'500':
description: The request failed due to an unexpected server error.
对于大多数响应代码,我不返回任何响应正文,但对于400响应
代码,我想返回错误对象:
Error:
type: object
properties:
code:
type: string
message:
type: string
required:
- code
- message
当我为此终结点生成Java服务器代码时,方法的返回类型
是ResponseEntity<Void>
,表示无法返回错误对象?
似乎类似于以下问题:
https://groups.google.com/forum/#!topic/swagger-swaggersocket/ygVjA2m5gY0
https://github.com/swagger-api/swagger-codegen/issues/7743
https://github.com/swagger-api/swagger-codegen/issues/4398
我不知道这是不是已经修复的问题,或者是否有解决此问题的方法?
解决方案
我使用了下面介绍的方法here来解决这个问题:
@Override
public ResponseEntity<Void> deleteThing(...)
{
try {
myService.deleteThing(...);
return new ResponseEntity<>(HttpStatus.NO_CONTENT);
} catch (MyException e) {
throw new ResponseStatusException(HttpStatus.NOT_FOUND, e.getMessage());
}
catch (MyOtherException e) {
throw new ResponseStatusException(HttpStatus.BAD_REQUEST, e.getMessage());
}
}
相关文章