为了减少程序员撰写文档时间,提高生产力,Swagger2 应运而生,使用 Swagger2 可以减少编写过多的文档,只需要通过代码就能生成文档API提供给前端人员对接,非常方便。
在 foodie-dev 的 pom 文件里添加 Swagger 2 依赖
<!-- swagger2 配置 -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>
<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>
在 foodie-dev-api 模块下的 com.imooc.config 包内创建 Swagger2 配置类
package com.imooc.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;
/**
* Created by 92578 on 2020/8/16 22:09
**/
@Configuration
@EnableSwagger2
public class Swagger2 {
// http://localhost:8088/swagger-ui/index.html 原路径
// http://localhost:8088/doc.html
// 配置 swagger2 核心配置 docket
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2) // 指定 api 类型为 swagger2
.apiInfo(apiInfo()) // 用于定义 api 文档汇总信息
.select()
.apis(RequestHandlerSelectors.basePackage("com.imooc.controller")) // 指定 controller 包
.paths(PathSelectors.any()) // 所有 controller
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("天天吃货 电商平台接口api") // 文档页标题
.contact(new Contact("imooc", "https://www.imooc.com", "abc@imooc.com")) // 联系人信息
.description("专为天天吃货提供的 api 文档") // 详细信息
.version("1.0.1") // 文档版本号
.termsOfServiceUrl("https://www.imooc.com") // 网站地址
.build();
}
}
访问 http://localhost:8088/swagger-ui.html 打开 swagger2 页面
通过文档可以测试接口,选择 usernameIsExist 接口 -> Try it out -> 输入 username ->Execute
提示用户名已经存在
访问 http://localhost:8088/doc.html 可以换成 bootstrap 皮肤风格
测试 usernameIsExist 接口