当前位置:网站首页>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");
边栏推荐
- @JsonBackReference和@JsonManagedReference(解决对象中存在双向引用导致的无限递归)
- 游戏解包的危害及资源加密的重要性
- 2022.02.13 - NC001. Reverse linked list
- Restful API design specification
- 【刷题】牛客网面试必刷TOP101
- 【ROS】usb_cam相机标定
- 2022 Inner Mongolia latest water conservancy and hydropower construction safety officer simulation examination questions and answers
- Shift Operators
- torch建立的网络模型使用torchviz显示
- Deep learning: derivation of shallow neural networks and deep neural networks
猜你喜欢
Cisp-pte practice explanation
What is CSRF (Cross Site Request Forgery)?
深度剖析C语言数据在内存中的存储
TCP/IP协议
Sublime text in CONDA environment plt Show cannot pop up the problem of displaying pictures
MySQL learning record 11jdbcstatement object, SQL injection problem and Preparedstatement object
synchronized 解决共享带来的问题
View computer devices in LAN
Ruffian Heng embedded bimonthly, issue 49
根据csv文件某一列字符串中某个数字排序
随机推荐
C language double pointer -- classic question type
Colorlog combined with logging to print colored logs
What is CSRF (Cross Site Request Forgery)?
Fibonacci sequence
JVM performance tuning and practical basic theory - Part 1
Colorlog结合logging打印有颜色的日志
The network model established by torch is displayed by torch viz
egg. JS project deployment online server
Is it safe to open an account in Zheshang futures?
China vanadium battery Market Research and future prospects report (2022 Edition)
[secretly kill little partner pytorch20 days -day01- example of structured data modeling process]
JVM 快速入门
Sublime text in CONDA environment plt Show cannot pop up the problem of displaying pictures
企微服务商平台收费接口对接教程
ROS compilation calls the third-party dynamic library (xxx.so)
VMware 虚拟化集群
leetcode刷题 (5.29) 哈希表
Trying to use is on a network resource that is unavailable
swagger设置字段required必填
Leetcode question brushing (5.31) string