@ApiParam @PathVariable @RequestParam有哪些区别

本文详细介绍了如何在Spring Boot API开发中使用@ApiParam为参数提供文档,包括@RequestParam用于GET/POST请求参数,以及@PathVariable绑定URL路径参数。通过实例展示如何确保前后端参数对应,并生成高质量的开发者文档。
摘要由CSDN通过智能技术生成

1.@ApiParam 顾名思义,是注解api的参数,也就是用于swagger提供开发者文档,文档中生成的注释内容。

  

@ApiOperation( value = "编辑公告", notes = "编辑公告", httpMethod = "POST" )
    @RequestMapping( value = "/edit", method = RequestMethod.POST )
    public RequestResult edit(
            @ApiParam(name = "title", value = "公告标题", required = true) @RequestParam("title") String title,
            @ApiParam(name = "content", value = "公告内容", required = true) @RequestParam("content") String content){

2.@RequestParam,是获取前端传递给后端的参数,可以是get方式,也可以是post方式。其中如果前端传递的参数和后端你接受的参数起的名字字段是一致的可以省略不写,也可以直接写@RequestParam String title,如果不一致一定要完整写,不然获取不到,如下面的bis_key就必须写。

@ApiOperation( value = "编辑公告", notes = "编辑公告", httpMethod = "POST" )
    @RequestMapping( value = "/edit", method = RequestMethod.POST )
    public RequestResult edit(
            @ApiParam(name = "bis_key", value = "bis_key", required = true) String bisKey,
            @ApiParam(name = "title", value = "公告标题", required = true) @RequestParam String title,
            @ApiParam(name = "content", value = "公告内容", required = true)  String content,

3.@PathVariable,是获取get方式,url后面参数,进行参数绑定

@ApiOperation(value = "删除公告", notes = "删除公告", httpMethod = "POST")
    @RequestMapping(value = "/delete/{bisKey}", method = RequestMethod.POST)
    public RequestResult remove(@ApiParam(name = "bisKey", value = "需要删除的公告ids", required = true) @PathVariable String bisKey) {
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
@RequestParam和@ApiParam是两个不同的注解,用于在接口中定义参数。 @RequestParam注解用于获取前端传递给后端的参数。它可以用在方法的参数上,用于指定参数的名称、是否必传等属性。例如,在方法参数上使用@RequestParam注解可以获取前端传递的id参数,如下所示: ```java public DataResult<ZonesEiaPlanPageInfoVO> detail(@RequestParam(value = "id", required = false) String id) {} ``` 在这个例子中,@RequestParam注解指定了参数名称为id,required属性为false,表示id参数不是必传的。 @ApiParam注解用于在接口文档中描述参数的名称、描述等信息。它可以用在方法的参数上,用于指定参数的名称、描述等属性。例如,在方法参数上使用@ApiParam注解可以描述参数的名称为主键,如下所示: ```java public DataResult<ZonesEiaPlanPageInfoVO> detail(@RequestParam @ApiParam(value = "主键") String id) {} ``` 在这个例子中,@ApiParam注解指定了参数的描述为主键。 总结来说,@RequestParam注解用于获取前端传递的参数,而@ApiParam注解用于在接口文档中描述参数的信息。它们的作用不同,但可以一起使用来提供更详细的接口文档信息。 #### 引用[.reference_title] - *1* *2* [@RequestParam和 @ApiParam注解使用](https://blog.csdn.net/qq_43960622/article/details/126146392)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^insert_down1,239^v3^insert_chatgpt"}} ] [.reference_item] - *3* [@ApiParam @PathVariable @RequestParam三者区别](https://blog.csdn.net/qq_39505065/article/details/107981916)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v91^insert_down1,239^v3^insert_chatgpt"}} ] [.reference_item] [ .reference_list ]
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值