有了 Swagger,再也不用写 API说明文档啦

前言

Swagger 是什么？

• Swagger 是一款RESTFUL接口的、基于YAML、JSON语言的文档在线自动生成、代码自动生成的工具。

1.作用：

1. 启动项目后在线自动生成API文档
2. 在线高效调试

2.官网：https://swagger.io

knife4j 是什么？

• 为Java MVC框架集成Swagger的增强解决方案-前身是 swagger-bootstrap-ui
• swagger-bootstrap-ui是springfox-swagger的增强UI实现，为Java开发者在使用Swagger的时候，能拥有一份简洁、强大的接口文档体验

1.作用：

1. 接口排序
2. 自定义文档说明
3. 访问权限控制
4. 请求参数缓存
5. 调试动态请求参数
6. 文档说明等

2.官网：https://doc.xiaominfo.com

整合

一、pom.xml 引入 依赖

<!-- swagger2-->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.9.2</version>
			<exclusions>
			    <exclusion>
			        <groupId>io.swagger</groupId>
			        <artifactId>swagger-annotations</artifactId>
			    </exclusion>
			    <exclusion>
			        <groupId>io.swagger</groupId>
			        <artifactId>swagger-models</artifactId>
			    </exclusion>
			</exclusions>
		</dependency>
		
		<!--防止进入swagger页面报类型转换错误，排除2.9.2中的引用，手动增加1.5.21版本-->
        <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>sw