完整代码详见:
https://gitee.com/never_enough/Springboot_Swagger
参考SpringMVC集成Swagger插件以及Swagger注解的简单使用,链接如下:
[https://www.jianshu.com/p/67c9b84226cd]
1.依赖
如果是maven依赖的话:
<!--swagger2-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.8.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.8.0</version>
</dependency>
2.注解
3. 配置文件
@Configuration
@EnableSwagger2
public class Swagger2 {
//swagger2的配置文件,这里可以配置swagger2的一些基本的内容,比如扫描的包等等
//.apiInfo(apiInfo()) //调用下面apiInfo()方法
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
//为当前包路径
//.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.apis(RequestHandlerSelectors.basePackage("com.example.demo.controllerDemo"))
.paths(PathSelectors.any())
.build();
}
//构建 api文档的详细信息函数,注意这里的注解引用的是哪个
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
//页面标题
.title("这是标题Spring Boot 测试使用 Swagger2 构建RESTful API")
//创建人
.contact(new Contact("stt", "http://www.baidu.com", ""))
//版本号
.version("1.0")
//描述
.description("这是API 描述")
.build();
}
}
有的还说要在application.yml配置一下这个: