swagger入门

最新推荐文章于 2025-03-17 09:13:33 发布

618GLOAL_COOK2237

最新推荐文章于 2025-03-17 09:13:33 发布

阅读量224

点赞数

分类专栏： Blog

本文链接：https://blog.youkuaiyun.com/GLOAL_COOK/article/details/119867502

版权

Blog 专栏收录该内容

4 篇文章

订阅专栏

本文档介绍了如何在Spring Boot项目中引入Springfox，通过Swagger2为API创建交互式文档。首先，从Maven仓库导入Springfox的swagger2和swagger-ui依赖。接着，配置Swagger2的@EnableSwagger2注解，创建SwaggerConfig配置类。然后，在Controller层使用@Api和@ApiOperation注解来标注模块和方法。这使得开发者能够快速生成清晰的文章管理模块接口说明。

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

pom导入：

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

定义一个配置类：

@Configuration
@EnableSwagger2
public class SwaggerConfig {
}

在controller加上注解：

@Api(tags = "文章管理模块")

想要提示的方法加上：

@ApiOperation("文章列表")

在这里插入图片描述