Swagger的基本使用（快速入门）

目录

一、环境配置

（1）导入依赖：（一般导入依赖都会报错，所以大家也可以借鉴一下这篇文章：swagger配置报错）

（2）启动类添加注解

二、Swagger配置介绍

（1）基本配置 

（2）设置扫描的包

三、Swagger常用注解

（1）@Api

（2）@ApiOperation

（3）@ApiParam

（4）@ApiModel

（5）@ApiIgnore

（6）@ApiImplicitParam

在使用Swagger前，首先我们要知道什么事Swagger。

接口文档对于前后端开发人员都十分重要。尤其近几年流行前后端分离后接口文档又变成重中之重。接口文档固然重要，但是由于项目周期等原因后端人员经常出现无法及时更新，导致前端人员抱怨接口文档和实际情况不一致。很多人员会抱怨别人写的接口文档不规范，不及时更新。如果接口文档可以实时动态生成就不会出现上面问题，Swagger可以完美地解决上面的问题。Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful 风格的 Web 服务，可用于接口的文档在线自动生成以及功能测试。

我们一般都是通过springfox来使用Swagger

一、环境配置

（1）导入依赖：（一般导入依赖都会报错，所以大家也可以借鉴一下这篇文章：swagger配置报错）

  io.springfox
  springfox-swagger2
  2.9.2


  io.springfox
  springfox-swagger-ui
  2.9.2

（2）启动类添加注解

@SpringBootApplication
@EnableSwagger2
public class MyApp {
    public static void main(String [] args){
        SpringApplication.run(MyApp.class,args);
    }
}

二、Swagger配置介绍

（1）基本配置 

@Configuration
public class SwaggerConfiguration {
    @Bean
    public Docket getDocket() {
        return new Docket(DocumentationType.SWAGGER_2)