为方便本地接口测试和前后端联调,生成简洁易用的接口文档,可通过Springboot集成
Swagger2和knife4j,这比Swagger官方提供的框架更加好用。
1、pom引入以下2个依赖。
<dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-ui</artifactId> <version>3.0.3</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>3.0.0</version> </dependency>
2.代码配置,在工程config包下,新建一个配置类,名称随意。
@Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket customDocket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.otitan.swa.controller"))//扫描的包路径 .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("泰坦尼克号接口文档") .version("otitan:1.0.0") .build(); } }
3.启动工程 访问接口文档 localhost:port/doc.html。(当然在controller类中加入swagger相关的注解,主要是类上加@Api(tags={"xxx接口"}),方法上加@ApiOperation("xxxx查询")
)