Springoot整合Swagger2

最新推荐文章于 2025-01-07 15:45:12 发布

fly1157932256

最新推荐文章于 2025-01-07 15:45:12 发布

阅读量107

点赞数

分类专栏： java 文章标签： spring boot maven intellij-idea swagger2

本文链接：https://blog.youkuaiyun.com/fly1157932256/article/details/123197998

版权

java 专栏收录该内容

7 篇文章

订阅专栏

没有检索到摘要

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

在前后端分离的比较流行的今天，接口文档的使用可以大大调高开发效率，而Swagger就是为此而生的。（一本正经的胡说^_^），接下来言归正题。

1.新建一个SpringBoot项目或者Maven项目

（略过相信大家都会创建项目了）

2.引入Swagger2依赖

             <!--引入swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.8.0</version>
        </dependency>
        <!--引入swagger-ui-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.8.0</version>
        </dependency>

3.配置Swagger2

package com.asus.swagger_security.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket getDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.asus.swagger_security.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("ASUS API文档")
                .description("power by hsh,hsh@qq.com")
                .termsOfServiceUrl("https://blog.youkuaiyun.com/fly1157932256?spm=1008.2028.3001.5343")
                .version("1.0")
                .build();
    }
}

配置完成后，就可以使用http://127.0.0.1:{port}/swagger-ui.html访问Swagger的UI界面了。