Swagger2简单配置说明
程序员文章站
2022-06-25 12:08:39
...
说明:
1. 引入依赖
父工程pom.xml 文件中添加:
<!-- swagger2 配置依赖 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.4.0</version>
</dependency>
<dependency> <!-- 自带的ui -->
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.4.0</version>
</dependency>
<dependency> <!-- 其他人员开发的ui -->
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.6</version>
</dependency>
2. 新建Swagger2配置类
package com.wh.blog.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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration //让Spring容器扫描到
@EnableSwagger2 //Swagger2配置
public class Swagger2 {
// 访问路径:
// http://localhost:8058/swagger-ui.html 原路径
// http://localhost:8058/doc.html 原路径
//配置swagger2核心配置 docket
@Bean
public Docket createRestApi(){
return new Docket(DocumentationType.SWAGGER_2) //指定Api类型为Swagger2
.apiInfo(apiInfo()) //用于定义api文档汇总信息
.select()
.apis(RequestHandlerSelectors
.basePackage("com.wh.blog.controller")) //指定controller包
.paths(PathSelectors.any()) //所有controller
.build(); //构建
}
private ApiInfo apiInfo(){
return new ApiInfoBuilder()
.title("小渺博客平台接口") // 文档页标题
.contact(new Contact("小渺","https://blog.csdn.net/wh_first2018","aaa@qq.com")) //联系人信息
.description("小渺的博客网站,欢迎大家支持。") //详细信息描述
.version("1.0.1") //文档版本号
.termsOfServiceUrl("暂时无") //网站地址,暂时无
.build(); //构建返回
}
}
3. 显示效果
官方效果:http://localhost:8058/swagger-ui.html
其他效果:http://localhost:8058/doc.html
下一篇: 在VMware上配置Centos7网络