Springboot集成Swagger，生成Api文档

末蓝、 2022-01-21 23:51 470阅读 0赞

一.pom.xml文件集成swagger环境依赖

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

二.编写swagger配置config类

import org.springframework.context.annotation.Bean;  
import org.springframework.context.annotation.Configuration;

import io.swagger.annotations.ApiOperation;  
import springfox.documentation.builders.RequestHandlerSelectors;  
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 swaggerSpringMvcPlugin() \{  
            return new Docket(DocumentationType.SWAGGER\_2).select()  
                    .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).build();  
        \}  
\}

三.在启动类配置扫码包

@EnableAutoConfiguration  
@SpringBootApplication(scanBasePackages="com.dhl")//包名，根据自己情况而定  
public class ExternalSysApplication \{

public static void main(String\[\] args) \{  
        SpringApplication.run(ExternalSysApplication.class, args);  
    \}  
\}  
四.启动项目之后，访问swagger界面

localhost:8100/swagger-ui.html,访问端口，可以自己修改,效果图如下

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3k1MzI3OTgxMTM_size_16_color_FFFFFF_t_70][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3k1MzI3OTgxMTM_size_16_color_FFFFFF_t_70 1][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3k1MzI3OTgxMTM_size_16_color_FFFFFF_t_70]: /images/20220122/a01b78d8910243b0aa6b867d6a6288fa.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3k1MzI3OTgxMTM_size_16_color_FFFFFF_t_70 1]: /images/20220122/9235110568ab428ca6b8f1bb22539b19.png