@ApiParam @PathVariable @RequestParam

逃离我推掉我的手 2021-09-28 08:48 362阅读 0赞

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) {

@RequestPart与.@RequestParam

@RequestPart这个注解用在multipart/form-data表单提交请求的方法上。   
2.支持的请求方法的方式MultipartFile，属于Spring的MultipartResolver类。这个请求是通过http协议传输的。   
3.@RequestParam也同样支持multipart/form-data请求。   
4.他们最大的不同是，当请求方法的请求参数类型不再是String类型的时候。   
5.@RequestParam适用于name-valueString类型的请求域，@RequestPart适用于复杂的请求域（像JSON，XML）。