springboot swagger的使用

最新推荐文章于 2025-05-30 11:24:46 发布

原创最新推荐文章于 2025-05-30 11:24:46 发布 · 116 阅读

0 ·

CC 4.0 BY-SA版权

springboot 专栏收录该内容

32 篇文章

订阅专栏

本文详细介绍了如何在SpringBoot项目中集成Swagger，包括导入依赖、配置注解以及使用各种Swagger注解来描述API的方法和参数，使API文档自动生成。

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

1.导入依赖
<!--swagger开始-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

         <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
<!--swagger结束-->
2.在主类上声明

@SpringBootApplication
@EnableSwagger2
public class SpringbootApplication {

    public static void main(String[] args) {

        SpringApplication.run(SpringbootApplication.class, args);
    }

}

3.各种注解 
  http://localhost:8083/swagger-ui.html 访问

@ApiOperation(value = "用户查询服务") 写在方法上 说明这个方法是干嘛的
@ApiParam("用户id") 写在参数上 说明参数是干嘛的
@@ApiModelProperty("用户姓名") 写在实体类