Как обрабатывать несколько типов ответа / возврата (пусто для 204, непусто для 400 и c) в коде swagger? - PullRequest
0 голосов
/ 20 февраля 2020

Я использую openapi версии 3.0.2.

У меня есть следующее spe c, которое описывает мои ответы:

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:

Error:
    type: object
    properties:
        code:
            type: string
        message:
            type: string
    required:
        - code
        - message

Когда я генерирую код сервера Java для этой конечной точки, тип возвращаемого значения для метода - ResponseEntity<Void>, что означает, что я не могу вернуть объект Error?

Похоже на следующие проблемы:

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

Я не знаю, было ли это что-то, что уже исправлено, или есть ли обходной путь для этого?

1 Ответ

1 голос
/ 25 февраля 2020

Я использовал следующий подход, описанный здесь , чтобы решить эту проблему:

@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());
        }
}
...