swagger设置字段required必填

swagger注解中需要设置请求参数的字段是必须填写的还是非必须的。我们需要添加下面的配置。只需要在对象的字段中增加下面的代码

@ApiModelProperty(value = "自建应用的corpid", required = true)

显示效果如下

详细的代码如下

请求的controller代码

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 = {"自建应用服务"})
@RequestMapping("/myApp")
@Slf4j
public class MyAppController extends BaseController {@Autowiredprivate MyAppService myAppService;@ApiOperation(value = "自建应用-推送图文消息给用户",notes = "逻辑如下："+ MyConstants.SWAGGER2_FOX_BR_TAG +MyConstants.SWAGGER2_FOX_BR_TAG)@RequestMapping(value = "/sendNews", method = RequestMethod.POST)@ResponseBodypublic 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);}}

请求参数对象

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 = "图文消息对象"
)
@Data
@Slf4j
@Builder
@NoArgsConstructor
@AllArgsConstructor
@Accessors(chain = true)
public class MyAppSendNewsReqBean implements Serializable {@ApiModelProperty(value = "企微自建应用，接收消息的用户ID，多个接收者用‘|’分隔，最多支持1000个）。@all=全员发送", required = true)@NotNull(message = "userId不能为空")private String userId;@ApiModelProperty(value = "自建应用的corpid", required = true)@NotNull(message = "corpid不能为空")private String corpid;@ApiModelProperty(value = "自建应用的corpsecret", required = true)@NotNull(message = "corpsecret不能为空")private String corpsecret;@ApiModelProperty(value = "自建应用的agentId", required = true)@NotNull(message = "agentId不能为空")private Integer agentId;@ApiModelProperty(value = "图文消息的标题", required = true)@NotNull(message = "title不能为空")private String title;@ApiModelProperty(value = "图文消息的描述")private String description;@ApiModelProperty(value = "点击图片跳转的网址，网址必须是备案的网址，否则会有风险提示")private String url;@ApiModelProperty(value = "图片地址", required = true)@NotNull(message = "picUrl不能为空")private String picUrl;}

启动项目，访问swagger，访问地址如下

log.info("swagger api=http://ip:port/项目名称/swagger-ui.html");
log.info("swagger api=http://ip:port/项目名称/doc.html");

swagger设置字段required必填相关推荐

eas 税率修改_如何修改金蝶EAS业务单据中的字段为必填项
关于金蝶EAS的使用所需要注重到的方面有很多,当然在具体使用的时候还是要看不同的功能,因为功能不同在后续的效果上也不同,尤其是在金蝶EAS的管理功能中所涉及到的层面也更多,因此在相关的因素上也一定要注 ...
mysql修改字段非必输_mysql有些字段是非必填的，传空要查所有数据该怎么处理？...
如果你在设计表结构的时候,没给有给 char 类型字段设置默认值(如 ''),那么在mysql 他存储的就是null 所以,如果你是要查指定cityId 并且 regionId 为空的sql 就这么写 ...
泛微E9 属性联动JS - 明细字段的只读/编辑/必填/隐藏
参考泛微在线文档 (e-cloudstore.com) E9前端的所有接口统一封装在全局对象window.WfForm中,大部分操作都可使用WfForm实现.虽然官方不建议使用jquery,但有些需 ...
ArcGis国土空间”一张图”填报操作技巧（四）零编程基础批量添加字段并设置字段属性
向表或要素类表.要素图层和/或带属性表的栅格添加字段并设置字段属性,是我们在数据建库或处理时常常要用到的操作,实现的方法非常多. 一.逐一添加字段的常见操作 1.打开属性表--添加字段. 2.使用字段 ...
SAP SD 销售凭证如何设置字段必填
在实际业务中,我们经常遇到需要设置某些字段是必输的.那么在SAP中创建销售订单时如何控制必填字段呢?请看操作手册第一步:设置屏幕增强 T-CODE:shd0 上截图 1----输入需要控制的事物代码 ...
html file字段必填,input将表单内容设置为必填
带有必填字段的表单: 这个是很简单的 Name: 这个是小窗口提醒输入: 姓名: *8个字内 required 属性规定必需在提交之前填写输入字段. maxLength=8 字数限制8 如果使用该属性 ...
java 字段验证_Selenium-Gherkin-Java:验证必填字段上的文本
简短版:我有一个必填字段,显示"此字段是必需的"的元素可以包含多个消息.我正在努力设置我的BDD功能步骤.页面和步骤文件,以验证是否显示了正确的消息. 长版: 对Java/Sele ...
如何设置dedecms自定义表单必填项？
用dedecms自定义表单可以制作一个简单的预约系统,有些相关信息需要设置为必填项,比如联系方式,没有留下真实的电话或其他信息,以后要怎么联系到你的客户.那我们要如何设置织梦cms自定义表单必填项呢? ...
inputNumber设置必填项
设置input必填项时,写法如下: <a-form-model :model="form" :rules="rules"><a-form-mo ...
html5 表单必填项,javascript - HTML5表单必填属性。设置自定义验证消息？
javascript - HTML5表单必填属性. 设置自定义验证消息? 我有以下HTML5表格:[http://jsfiddle.net/nfgfP/] ***** 目前当我在空白时点击输入时,会出 ...

swagger设置字段required必填

swagger设置字段required必填相关推荐

最新文章

热门文章