欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

swagger2简单的配置步骤

程序员文章站 2022-06-25 12:11:12
...

看有些springboot的项目还没有配置swaggger2接口文档的时候觉得不错所以项目简单引用下
1.pom文件引用

父类pom

  			 <!--- swagger2  -->
  			 maven中的dependencyManagement标签内
            <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>

子类项目中pom引用
		 <!-- swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>


上面这样配置maven配置的一个通用路子

  1. swagger2配置文件配置
    RequestHandlerSelectors.basePackage(“com.github.security.auth.controller”) 这个提出来说下,需要注意的是放自己的controller的包位置
/**
 * @ClassName SwaggerConfig
 * @Description TODO
 * @Author tanli
 * @Date 2020-06-09
 * @Since 1.0
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .pathMapping("/")
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.github.security.auth.controller"))
                    .paths(PathSelectors.any())
                    .build().apiInfo(new ApiInfoBuilder()
                            .title("SpringBoot整合Swagger")
                            .description("SpringBoot整合Swagger,详细信息......")
                            .version("9.0")
                            .contact(new Contact("测试","blog.csdn.net","aaa@qq.com"))
                            .license("The Apache License")
                            .licenseUrl("http://www.csdn.com")
                            .build());
        }

}

如上配置完之后重启项目

输入地址:http://IP:端口/swagger-ui.html
得到页面如图:
swagger2简单的配置步骤
简单的引用就已经可以用了,
设置多个个选择框可以看我另一篇文档
https://blog.csdn.net/iteye_9328/article/details/103120925

相关标签: swagger maven