1、导入依赖
参考代码如下:
<!--swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!--swagger-ui.html模式 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<!--doc.html模式 -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.2</version>
</dependency>
2、写配置文件
@Configuration
@EnableSwagger2
@Profile("swagger")
public class SwaggerConfig {
/**
* 创建API应用 apiInfo() 增加API相关信息
* 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现,
* 本例采用指定扫描的包路径来定义指定要建立API的目录。
*
* @return
*/
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).pathMapping("/").select() // 选择那些路径和api会生成document
.apis(RequestHandlerSelectors.any())// 对所有api进行监控
.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class)).build()
.globalOperationParameters(setHeaderToken());// 配置token
}
// 配置token
private List<Parameter> setHeaderToken() {
ParameterBuilder tokenPar = new ParameterBuilder();
List<Parameter> pars = new ArrayList<>();
tokenPar.name("Authorization").description("token").modelRef(new ModelRef("string")).parameterType("header")
.required(false).build();
pars.add(tokenPar.build());
return pars;
}
/**
* 创建该API的基本信息(这些基本信息会展现在文档页面中) 访问地址:http://项目实际地址/swagger-ui.html
*
* @return
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("资金众筹网站接口文档").description("资金众筹网站接口文档").version("1.0").build();
}
}
注意:@EnableSwagger2作用是开启Swagger,@Configuration作用是将该类标记为配置类,在springboot启动时,自动装备配可以将该类识别为配置类,类似于yml文件,@Profile("swagger")作用是在通过yml配置文件开启该类时通过swagger进行识别。基础用法,不需要使用@Configuration注解和@Profile()注解。
3、在启动类加注解
@EnableSwagger2
开启Swagger
4、在控制层写注解(具体使用Swagger)
@Api(tags = "订单接口管理")
@RestController
public class DingdanController {
@Resource
private DingdanService dingdanService;
@Resource
private WithDrawalService withDrawalService;
@Resource
private BankCardService bankCardService;
//查询所有订单,根据订单状态(1:已处理,向钱包表加相应金额,2:待处理)
@CrossOrigin
@ApiOperation(value = "查询订单列表")
@GetMapping("getAllDingdan")
@ApiImplicitParams({
@ApiImplicitParam(name = "type", value = "订单类型", paramType = "Integer"),
@ApiImplicitParam(name = "pageNum", value = "每页数量", paramType = "Integer"),
@ApiImplicitParam(name = "pageSize", value = "页码", paramType = "Integer")
})
public Result getAllDingdan(Integer type,Integer pageNum,Integer pageSize){
//[pagenum, pagesize] 页码 每页显示数量
PageHelper.startPage(pageNum,pageSize);
PageInfo<VccDingdan> pageInfo = new PageInfo<>(dingdanService.getAllDingdan(type));
return Result.succ("成功",pageInfo);
}
@ApiOperation(value = "展示产品列表")
@PostMapping("/getProductList")
@MyLog(systemFunctionName = "产品管理", systemFunctionUrl = "/productController/getProductList", userOperationType = 4, userOperationSummary = "展示产品列表")
public BaseResponse<IPage<ProductBO>> getProductList(@RequestBody ProductVO productVO) {
logger.info("展示产品列表");
return RespGenerator.returnOK(productService.getProductList(productVO, 1));
}
@Api(tags = ""),填写控制层名称
@ApiOperation(value = ""),填写接口名
注意:当接口是get请求时,需要将每一个入参进行描述,使用@ApiImplicitParams()注解,具体如上图,当接口是post请求时,由于入参是一个对象,所以将描述写在入参对象里面即可。
5、在其他实体类BOVO上加注解
@Data
@ApiModel("新增附加险关联记录VO类")
public class AddAdditionalInsuranceVO implements Serializable {
/** serialVersionUID */
private static final long serialVersionUID = -2297675964964088040L;
@ApiModelProperty(value = "建议书id",required = true)
private String recommendationId;
@ApiModelProperty(value = "附加险id",required = true)
private Integer additionalInsuranceId;
}
@ApiModel("")注解填写对象名称,此处是入参VO类,出参BO类于此一致。@ApiModelProperty(value = "建议书id",required = true)注解,value属性填写字段名称,required 属性填写是否必填,生成接口文档时方便前端了解该字段是否必填,用于传入参数VO上,默认是false。
小白一枚,勿喷。