使用Swagger只需要按照它的规范去定义接口,就可以生成各种格式的接口文档和在线调试页面。
knife4j:Java MVC框架集成Swagger的产物,用来生成Api文档。
使用方式
- 导入knife4j的maven坐标
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>3.0.2</version>
</dependency>
- 导入knife4j相关配置
- 在
WebMvcConfig类上添加注解@EnableSwagger2 @EnableKnife4j - 添加两个方法
@Bean public Docket createRestApi() { // 文档类型 return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.ztx.controller")) // 注意修改包名 .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("瑞吉外卖") .version("1.0") .description("瑞吉外卖接口文档") .build(); }
- 设置静态资源映射
registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
- 在拦截器中设置放行的路径