引入依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency
因为springboot的版本问题可能会出现错误
在配置文件上加上以下代码
spring:
application:
name:payment
mvc:
pathmatch:
matching-strategy: ant_path_matcher
编写配置类
/**
* Date:2022-04-28
* Author:win
* Description:springfox配置类
*/
@Controller
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket docket(){
return new Docket(DocumentationType.SWAGGER_2).apiInfo(new ApiInfoBuilder().title("微信支付案例接口文档").build());
}
}
使用注解表示接口
@Api(“controller名称”):作用在类上
@ApiOperation(“方法名”):作用在方法上
@RestController
@CrossOrigin
@Api("商品")
public class ProductController {
@Autowired
ProductService productService;
@GetMapping("/api/test")
public String test(){
return "hello";
}
@ApiOperation(value = "商品列表")
@GetMapping("/api/product/list")
public R list(){
return R.ok().data("productList",productService.list());
}
}
运行访问/swagger-ui.html,完成