1.在pom.xml文件中(如果是分布式项目,加到父工程pom.xml中)
<!-- swagger config 配置 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.4.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.4.0</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.6</version>
</dependency>
2.添加config配置类
@Configuration
@EnableSwagger2
public class Swagger2 {
//localhost:8088/swagger-ui.html 原始swagger页面
//localhost:8088/doc.html 美化之后的swagger页面
/**
* 配置swagger2核心配置 docket
* @return
*/
@Bean
public Docket createRestApi() {
//指定类型
return new Docket(DocumentationType.SWAGGER_2)
//定义api文档汇总信息
.apiInfo(apiInfo())
//配置扫描包所在的地址
.select()
.apis(RequestHandlerSelectors
.basePackage("com.wl.controller"))
//所有controller
.paths(PathSelectors.any())
.build();
}
/**
* 定义api个人信息
* @return api
*/
public ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("swagger 后台接口api")
.contact(new Contact("wl", "wl.com", "123456789@163.com"))
.description("专为前后台对接提供的api文档")
.version("1.0.1")
.termsOfServiceUrl("wl.com")
.build();
}
}
3.当你由于一些原因(安全性,隐私性)把有一些api隐藏
在xxxContraller类名上加上@ApiIgnore
4.英文api转化成中文文档
@Api(value = "注册登陆", tags = {"用于注册登录相关的接口"})
@RestController
@RequestMapping("passport")
public class PassportController {
@Autowired
private UserService userService;
@ApiOperation(value = "用户名是否存在", notes = "用户名是否存在", httpMethod = "GET")
@GetMapping("/usernameIsExist")
public Result userNameIsExist(@RequestParam String username) {
if (StringUtils.isNotEmpty(username)) {
return Result.errorMsg("用户名不能为空");
}
boolean isExist = userService.queryUsernameIsExist(username);
if (isExist) {
return Result.errorMsg("用户名已存在");
}
return Result.ok();
}
}
5.在pojo中加上详细提示
@ApiModel(value = "用户对象BO", description = "从客服端,由用户传输的数据,封装在次entity当中")
@Data
public class UserBO {
@ApiModelProperty(value = "用户名", name = "username", example = "imooc")
private String username;
@ApiModelProperty(value = "密码", name = "password", example = "123456")
private String password;
@ApiModelProperty(value = "确认密码", name = "confirmPassword", example = "和密码一致", required = false)
private String confirmPassword;
}