现在我们项目大部分都是前后端完全分离的一个项目,那么前端开发工程师则需要调用后端开发工程师所写的方法,哎~有小伙伴问了,我哪知道人家有哪些方法呀,人家方法格式是什么样的呀,需要哪些参数.......一系列问题所以中间就需要那么一个swagger合作开发文档来协作开发。
over~既然知道了swagger的重要性了,那我们就开始整合吧!
首先是导入依赖:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--swagger-->
<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>
当然因为我们要识别的是controller层的方法,所以我们这些操作都是在project_controller这一子模块中进行的哦。
导入完依赖之后记得刷新maven窝~
然后就是配置类:
SwaggerConfig
/**
* swagger 配置类
* @author shenwang
* @version 1.0
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
/****
* 接口配置
* @return
*/
@Bean
public Docket getClientDocket() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
//分组名称
.groupName("ahuaTestApi")
.select()
//扫描的包名称
.apis(RequestHandlerSelectors.basePackage("com.ahua.controller"))
.paths(PathSelectors.any())
.build();
}
/***
* 构建 api文档的详细信息函数
* @return
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("ahua测试-api接口文档")
.description("旺仔测试 api接口文档,里面提供便捷的api,和强大的功能")
.termsOfServiceUrl("http://www.baidu.com/")
.contact(new Contact("javaBoy_ahua", "https://blog.csdn.net/gloamer?spm=1001.2101.3001.5343", "910545306@qq.com"))
.version("1.0")
.build();
}
}
最后,启动项目访问:http://localhost:8080/swagger-ui.html#/
那个地址的端口号记得改成自己的呀
结果:
好啦~这样我们就整合完毕啦~