当前位置:网站首页>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");
边栏推荐
- win10系统中的截图,win+prtSc保存位置
- Shift Operators
- 电脑F1-F12用途
- 【ROS】usb_cam相机标定
- PC easy to use essential software (used)
- China's high purity aluminum target market status and investment forecast report (2022 Edition)
- Deep analysis of C language pointer
- Generator parameters incoming parameters
- C语言双指针——经典题型
- String to leading 0
猜你喜欢
随机推荐
tree树的精准查询
The ECU of 21 Audi q5l 45tfsi brushes is upgraded to master special adjustment, and the horsepower is safely and stably increased to 305 horsepower
Zhong Xuegao, who cannot be melted, cannot escape the life cycle of online celebrity products
Trying to use is on a network resource that is unavailable
Fibonacci sequence
Deep analysis of C language data storage in memory
Chrome浏览器的crash问题
@JsonBackReference和@JsonManagedReference(解决对象中存在双向引用导致的无限递归)
指针进阶---指针数组,数组指针
[NVIDIA development board] FAQ (updated from time to time)
MySQL learning records 12jdbc operation transactions
【MySQL】锁
pytorch训练好的模型在加载和保存过程中的问题
The network model established by torch is displayed by torch viz
JVM performance tuning and practical basic theory - Part 1
704 binary search
2022.02.13 - NC004. Print number of loops
LDAP應用篇(4)Jenkins接入
Roguelike游戏成破解重灾区,如何破局?
logback1.3. X configuration details and Practice









