java集成swagger

不念不忘少年蓝@ 2021-10-18 20:18 479阅读 0赞

本文写一下java集成swagger的主要步骤(留作记录)

1、引入swagger所需的jar包（版本可用2.6.1）

<dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.4.0</version>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.4.0</version>
            </dependency>

2、编写swagger启动类SwaggerConfig.java

package com.hnac.hzinfo.hznet.demo.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;
    
    @EnableSwagger2
    @Configuration
    public class DemoSwaggerConfig {
        @Bean
        public Docket petApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .enable(true)
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.hnac"))
                    .paths(PathSelectors.any())
                    .build();
    
        }
    
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder().title("HZNet演示平台API").description("").termsOfServiceUrl("http://localhost:8080/hznet-demo").version("1.0").build();
        }
    
    }

更详细的可以看看此文章：[https://blog.csdn.net/weixin\_42165041/article/details/81077100][https_blog.csdn.net_weixin_42165041_article_details_81077100]

[https_blog.csdn.net_weixin_42165041_article_details_81077100]: https://blog.csdn.net/weixin_42165041/article/details/81077100