Swagger: Пользовательский пример JSON тело запроса - PullRequest
Новая
       16

Swagger: Пользовательский пример JSON тело запроса

0 голосов
/ 19 марта 2020

У меня есть один вопрос о примере тела запроса в Swagger.

Это весь мой пример сущности пользователя: 

{
"id": 14,
"firstname": "fghfgh",
"lastname": "fghfghfgh",
"email": "customer",
"password": "pass",
"roles": [
    {
        "id": 3,
        "name": "customer"
    }
]

}

У меня есть метод регистра, который используйте User Entity в качестве параметра: 

    @ApiOperation(value = "Registering seller", response = User.class)
@PostMapping(value = "/seller/register")
public User addSeller(@RequestBody @Valid User user){
    return userService.addSeller(user);
}

Я использую конечную точку своего регистра с сущностью User без полей id и ролей (эти поля добавляются в бэкэнд)

Пример тела запроса регистра: 

{
    "firstname": "345345",
    "lastname": "fghfghfgh",
    "email": "customer3",
    "password": "pass"
}

В swagger моим примером тела запроса в соответствии с параметром является целая сущность User: enter image description here

, но я хочу получить пример тела запроса Swagger без идентификатора и ролей поля, как это сделать правильно? Я должен создать, например, класс UserRegister с полями имя, фамилия, адрес электронной почты и пароль и использовать его в качестве параметра метода регистрации? Или есть другой вариант с использованием объекта User в качестве параметра?

1 Ответ

0 голосов
/ 19 марта 2020

Кажется, вы используете JAVA.

Так что вы можете попробовать генератор кода чванства, чтобы решить эту проблему. Он поддерживает Java и создает классы моделей в соответствии с файлом swagger.yml.

Подробнее о генераторе кода swagger .

редакторе Swagger здесь .

...