【注解】@ApiParam @PathVariable @RequestParam

时间:2025-03-20 07:54:49

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

    @ApiOperation(value = "根据id查询")
    @GetMapping(value = {"/findById/{id}"})
    public ItooResult findById(@ApiParam(value = "主键id", required = true) @PathVariable String id) {
        PhoneticEntity phoneticEntity = (id);
        return (, "查询成功", phoneticEntity);
    }

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

    @ApiOperation(value = "查询-我的")
    @GetMapping(value = {"/findById"})
    public  ItooResult queryMineByUserId(@RequestParam String userCode){

        MineModel mineModel = (userCode);
        (null);
        return (,"查询成功",mineModel);
    }

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

    @ApiOperation(value = "根据id查询")
    @GetMapping(value = {"/findById/{id}"})
    public ItooResult findById(@ApiParam(value = "主键id", required = true) @PathVariable String id) {
        PhoneticEntity phoneticEntity = (id);
        return (, "查询成功", phoneticEntity);
    }