Spring Boot整合Swagger3注解@ApiImplicitParam的paramType属性为“path“

最新推荐文章于 2025-03-18 14:07:34 发布

y_bccl27

最新推荐文章于 2025-03-18 14:07:34 发布

阅读量1.3k

点赞数

分类专栏： Spring Boot 文章标签： swagger2

本文链接：https://blog.youkuaiyun.com/y_bccl27/article/details/120257299

版权

本文介绍了如何在Spring Boot中整合Swagger3，并展示了使用注解@ApiImplicitParam时，paramType设置为"path"的示例。通过这种方式，API接口在Swagger3文档中和Postman中的调用形式得到了详细说明。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Spring Boot整合Swagger3的依赖版本为：

<!--引入SpringBoot整合Swagger3的依赖-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

注解@ApiImplicitParam的paramType属性为"path"时的示例代码：

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;

@Api(tags = "系统管理")
@RestController
@RequestMapping("/sys")
public class SysController {

    @ApiOperation(value = "删除")
    @ApiImplicitParam(name = "id", value = "ID",paramType="path",dataTypeClass=Integer.class)
    @PostMapping("/del/{id}")
    public String delApprovals(@PathVari