整合swagger文档

最新推荐文章于 2025-04-10 03:56:19 发布

原创最新推荐文章于 2025-04-10 03:56:19 发布

· 334 阅读

0 ·

版权

文章标签：

#java

java 同时被 3 个专栏收录

8 篇文章

订阅专栏

swagger

1 篇文章

订阅专栏

maven

1 篇文章

订阅专栏

本文档介绍了如何在Java项目中集成Swagger2，通过配置类和启动器设置，实现http://localhost:8080/doc.html作为访问Swagger UI的入口。

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

所需要的包

 <!-- swagger2 & ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger2.version}</version>
            <scope>compile</scope>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger2.version}</version>
        </dependency>

        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>${swagger-bootstrap-ui.version}</version>
        </dependency>

swagger2配置类

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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * create by uking on 2020/6/16
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket CreateRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
        .groupName("***")
                .apiInfo(this.apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.gdu"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("API文档")
                .description("Java服务器")
                .termsOfServiceUrl("http://ip:port/doc.html")
                .contact(new Contact("uking","url",""))
                .version("1.0")
                .build();
    }
}

启动器


import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


@EnableSwagger2
@EnableSwaggerBootstrapUI
@SpringBootApplication
public class UserWebApplication {
    public static void main(String[] args){
        SpringApplication.run(UserWebApplication.class, args);
    }
}

访问URL http://localhost:8080/doc.html