Swagger:定制示例JSON请求正文

问题描述 投票:0回答:1

我对Swagger中的请求正文示例有一个问题。

这是我的整个用户实体示例:

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

}

我有注册方法,使用用户实体作为参数:

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

我将注册端点与没有ID和角色字段的用户实体一起使用(此字段添加在后端中)

示例注册请求正文:

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

大摇大摆地我根据参数的示例请求主体是整个用户实体:enter image description here

但是我想获得不带id和role字段的Swagger请求正文示例,如何以正确的方式做到这一点?我必须使用名字,姓氏,电子邮件和密码字段创建UserRegister类,并将其用作注册方法参数吗?还是使用用户实体作为参数的另一种选择?

java spring api swagger springfox
1个回答
-1
投票

似乎您正在使用JAVA。

因此,您可以尝试使用招摇代码生成器来解决该问题。它支持Java并根据swagger.yml文件创建Model类。

有关swagger code generator的更多信息。

Swagger编辑器here

© www.soinside.com 2019 - 2024. All rights reserved.