Swagger UI引入

最新推荐文章于 2025-06-06 19:05:04 发布

初尘19

最新推荐文章于 2025-06-06 19:05:04 发布

阅读量625

点赞数

CC 4.0 BY-SA版权

分类专栏：开发环境文章标签： swagger2

本文链接：https://blog.youkuaiyun.com/lanmuhhh2015/article/details/120159004

Swagger是一个用于生成Restful接口文档的框架，Swagger UI能自动生成并实时更新接口文档。本文介绍了如何通过4步操作：添加依赖、配置Swagger UI、在Controller上加注解，以及如何访问和测试生成的接口文档。

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

Swagger是一个Restful风格接口的文档在线自动生成和测试的框架（http://swagger.io），Swagger UI可以自动生成接口文档，不需要频繁更新接口文档，保证接口文档与代码的一致，代码改动时，接口文档可以自动修改。

1、添加依赖

<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>

2、添加swagger UI 配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                //apiInfo指定测试文档基本信息，这部分将在页面展示
                .apiInfo(apiInfo())
                .select()