【SpringBoot系列】接口参数的默认值与必要性

在SpringBoot中,我们可以通过@RequestParam注解为接口参数设置默认值,并通过@ApiParam注解为Swagger文档添加参数描述。

解决方案1:




@GetMapping("/getUser")
public User getUser(@RequestParam(value = "id", defaultValue = "0") Long userId) {
    return userService.getUserById(userId);
}

在上述代码中,我们通过@RequestParam注解的defaultValue属性为接口参数设置了默认值"0"。

解决方案2:




@GetMapping("/getUser")
public User getUser(@ApiParam(value = "用户ID", required = true) @RequestParam Long userId) {
    return userService.getUserById(userId);
}

在上述代码中,我们通过@ApiParam注解的value属性为Swagger文档添加了参数描述,并通过设置required属性为true表示该参数为必传参数。

注意:在SpringBoot中,接口参数的默认值和Swagger文档的参数描述需要分别使用@RequestParam的defaultValue属性和@ApiParam的value属性来设置,不能混淆使用。

最后修改于:2024年09月04日 21:23

评论已关闭

推荐阅读

Vue中使用mind-map实现在线思维导图
2024年08月04日
VUE
Web前端最全Vue实现免密登录跳转的方式_vue怎么样不登录返回首页,最强技术实现
2024年08月04日
VUE
vue3 项目搭建教程(基于create-vue,vite,Vite + Vue)
2024年08月04日
VUE
Vue-颜色选择器实现方案——>Vue-Color( 实战*1+ Demo*7)
2024年08月04日
VUE
Vue项目卡顿慢加载?这些优化技巧告诉你!_vue数据多渲染卡顿
2024年08月04日
VUE
vue中的keep-alive详解与应用场景
2024年08月04日
VUE
Vue、React实现excel导出功能(三种实现方式保姆级讲解)
2024年08月04日
vue-office/docx插件实现docx文件预览
2024年08月04日
VUE
java调用js文件的两种方法(支持V8引擎)
2024年08月04日
JavaScript:解决计算精度问题/mathjs/bignumber.js/big.js/decimal.js
2024年08月04日
两周从爬虫小白变大神 _yjs_js_security_passport
2024年08月04日
JS笔记(对象、函数、数组)
2024年08月04日
Markdown.js:强大的纯JavaScript Markdown解析器
2024年08月04日
Vue项目:js模拟点击a标签下载文件并重命名,URL文件地址下载方法、请求接口下载文件方法总结。
2024年08月04日
vue 父组件怎么获取子组件里面的data数据
2024年08月04日
VUE
个人开发实现AI套壳网站快速搭建(Vue+elementUI+SpringBoot)
2024年08月04日
el-table 表格封装并改造实现单元格可编辑
2024年08月04日
none
nodejs环境下创建vue项目、SSH密钥登陆!!!
2024年08月04日
vue+quill+element-ui实现视频、图片上传及缩放保姆级教程,轻松使用富文本
2024年08月04日
【three.js】22. Imported Models导入模型
2024年08月04日