当前位置:网站首页>Swagger setting field required is mandatory
Swagger setting field required is mandatory
2022-07-06 08:38:00 【renkai721】
swagger Is the field in the annotation that needs to set the request parameters mandatory or non mandatory . We need to add the following configuration . Just add the following code in the field of the object
@ApiModelProperty(value = " Self built application corpid", required = true)
The display effect is as follows
The detailed code is as follows
Requested controller Code
package my.controller;
import my.bean.*;
import my.common.BaseController;
import my.configuration.MyRedissonConfig;
import my.service.*;
import my.util.MsgUtil;
import my.util.MyConstants;
import my.util.WxUtil;
import my.wechataes.WXBizMsgCrypt;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.EnableAsync;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;
import springfox.documentation.annotations.ApiIgnore;
import javax.annotation.Resource;
import javax.servlet.ServletInputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.util.Map;
@EnableAsync
@RestController
@Api(value = "MyAppController",tags = {" Self built application service "})
@RequestMapping("/myApp")
@Slf4j
public class MyAppController extends BaseController {
@Autowired
private MyAppService myAppService;
@ApiOperation(value = " Self built application - Push graphic messages to users ",
notes = " The logic is as follows :"+ MyConstants.SWAGGER2_FOX_BR_TAG +
MyConstants.SWAGGER2_FOX_BR_TAG)
@RequestMapping(value = "/sendNews", method = RequestMethod.POST)
@ResponseBody
public String sendNews(@Validated @RequestBody MyAppSendNewsReqBean vo) {
String code = MyConstants.SUCCESS;
try {
log.info("myApp sendNews vo={}",vo);
myAppService.sendNews(vo);
} catch (Exception e) {
code = MyConstants.FAILURE;
e.printStackTrace();
}
return MsgUtil.outJson(code);
}
}
Request parameter object
package my.bean;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;
import lombok.extern.slf4j.Slf4j;
import javax.validation.constraints.NotNull;
import java.io.Serializable;
@ApiModel(
description = " Message object "
)
@Data
@Slf4j
@Builder
@NoArgsConstructor
@AllArgsConstructor
@Accessors(chain = true)
public class MyAppSendNewsReqBean implements Serializable {
@ApiModelProperty(value = " Enterprise and micro self built applications , Users receiving messages ID, For multiple receivers ‘|’ Separate , Most support 1000 individual )[email protected]= Send all ", required = true)
@NotNull(message = "userId Can't be empty ")
private String userId;
@ApiModelProperty(value = " Self built application corpid", required = true)
@NotNull(message = "corpid Can't be empty ")
private String corpid;
@ApiModelProperty(value = " Self built application corpsecret", required = true)
@NotNull(message = "corpsecret Can't be empty ")
private String corpsecret;
@ApiModelProperty(value = " Self built application agentId", required = true)
@NotNull(message = "agentId Can't be empty ")
private Integer agentId;
@ApiModelProperty(value = " Title of graphic message ", required = true)
@NotNull(message = "title Can't be empty ")
private String title;
@ApiModelProperty(value = " Description of graphic message ")
private String description;
@ApiModelProperty(value = " Click the image to jump to the website , The website must be the website for the record , Otherwise, there will be a risk prompt ")
private String url;
@ApiModelProperty(value = " Picture address ", required = true)
@NotNull(message = "picUrl Can't be empty ")
private String picUrl;
}
Start project , visit swagger, The address is as follows
log.info("swagger api=http://ip:port/ Project name /swagger-ui.html");
log.info("swagger api=http://ip:port/ Project name /doc.html");
边栏推荐
猜你喜欢
[brush questions] top101 must be brushed in the interview of niuke.com
根据csv文件某一列字符串中某个数字排序
IOT -- interpreting the four tier architecture of the Internet of things
生成器参数传入参数
[MySQL] lock
Cisp-pte practice explanation
What is CSRF (Cross Site Request Forgery)?
PLT in Matplotlib tight_ layout()
Zhong Xuegao, who cannot be melted, cannot escape the life cycle of online celebrity products
[MySQL] database stored procedure and storage function clearance tutorial (full version)
随机推荐
根据csv文件某一列字符串中某个数字排序
swagger设置字段required必填
JS inheritance method
[brush questions] top101 must be brushed in the interview of niuke.com
Ruffian Heng embedded bimonthly, issue 49
synchronized 解决共享带来的问题
Image,cv2读取图片的numpy数组的转换和尺寸resize变化
C语言双指针——经典题型
China Light conveyor belt in-depth research and investment strategy report (2022 Edition)
[MySQL] database stored procedure and storage function clearance tutorial (full version)
[MySQL] lock
[luatos-air551g] 6.2 repair: restart caused by line drawing
JS native implementation shuttle box
View computer devices in LAN
704 二分查找
Modify the video name from the name mapping relationship in the table
JVM performance tuning and practical basic theory - Part 1
sublime text没关闭其他运行就使用CTRL+b运行另外的程序问题
What is CSRF (Cross Site Request Forgery)?
LDAP应用篇(4)Jenkins接入