@ApiImplicitParam paramType: 'path' 解释 - Java Spring RESTful API 开发

@ApiImplicitParam(paramType = 'path', name = 'SysAdminParam', value = '条件查询信息')

在 Java Spring RESTful API 开发中，使用 @ApiImplicitParam 注解可以为接口方法参数添加说明信息，方便 API 文档生成。其中，paramType 属性用于指定参数的传递方式。

paramType = 'path' 表示该参数是通过 URL 路径传递的。

示例:

@GetMapping('/admin/{adminId}')
public SysAdmin getAdmin(@ApiImplicitParam(paramType = 'path', name = 'adminId', value = '管理员 ID') @PathVariable String adminId) {
    // ...
}

在这个示例中，adminId 参数是通过 URL 路径 /admin/{adminId} 传递的，paramType 设置为 'path' 表示该参数是通过 URL 路径传递的。

总结:

paramType = 'path' 用于指定参数通过 URL 路径传递，在定义 RESTful API 接口时，需要根据实际情况选择合适的 paramType 属性值。