一、添加依赖
与以前的相比,添加了优秀的开源项目
<!--swagger2 接口文档-->
<!--<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>-->
<!--交互页面-->
<!--<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency> -->
<!--相关注解-->
<!--
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.5.20</version>
</dependency>-->
<!--ui美化-->
<!--<dependency>
<groupId>com.github.caspar-chen</groupId>
<artifactId>swagger-ui-layer</artifactId>
<version>1.1.3</version>
</dependency>-->
<!--swagger-bootstrap-ui自1.9.6版本后,正式更名为knife4j-->
<!--<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-annotations</artifactId>
<version>2.0.4</version>
</dependency>
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-autoconfigure</artifactId>
<version>2.0.4</version>
</dependency>-->
<!--swagger + ui + 美化 及注解都包含再此-->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.4</version>
</dependency>
二、配置支持
@Configuration
@EnableSwagger2
@EnableKnife4j
/*@Import(BeanValidatorPluginsConfiguration.class)
@Profile({"local", "dev", "test"})*/
public class SwaggerConfig {
// 可添加自定义配置
// 参照swagger-layer-ui git项目
}
三、接口注解
四、实体类注解
五、生成接口文档示例
访问:http://localhost:8080/doc.html (自己程序的地址和端口)