第一步:引入依赖:
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.9</version>
</dependency>
第二步:配置类:
package com.unityAgainstBullying.common;
import io.swagger.annotations.Contact;
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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class Knife4jConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo()) // 配置 API 的一些基本信息,比如:文档标题title,文档描述description,文档版本号version
.select() //成 API 文档的选择器,用于指定要生成哪些 API 文档
.apis(RequestHandlerSelectors.basePackage("com.unityAgainstBullying.controller"))//指定要生成哪个包下的 API 文档
.paths(PathSelectors.any()) //指定要生成哪个 URL 匹配模式下的 API 文档。这里使用 PathSelectors.any(),表示生成所有的 API 文档。
.build();
}
//文档信息配置
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
// 文档标题
.title("反校园欺凌")
// 文档描述信息
.description("防校园欺凌用户文档")
// 文档版本号
.version("1.0")
.build();
}
}
第三步使用:主键,例如:
package com.unityAgainstBullying.controller;
import com.unityAgainstBullying.common.CommonConfig;
import com.unityAgainstBullying.service.UserService;
import com.unityAgainstBullying.util.User;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import javax.servlet.http.HttpSession;
@RestController
@RequestMapping("/user")
@Api(value = "用户层面的接口")
public class UserController {
@Autowired
private UserService userService;
/**
* 用户用验证码发送
* @param user
* @return
*/
@PostMapping("/code")
@ApiOperation("用户发送验证码")
public CommonConfig sendCode(@ApiParam("用户手机号") @RequestBody User user, HttpSession session){
userService.sendCode(user,session);
return CommonConfig.success();
}