springboot中使用Swagger

使用Swagger的原因

①简单易操作，文档可以动态生成，代码改变运行后文档自动生成。
②可以方便把接口信息等呈现给前端工程师
③有分组等功能，可以区分哪部分文档对应哪个开发者。
③后端工程师可以对接口进行简单的测试

使用Swagger的步骤

1. 创建springboot项目，导入Swagger需要的两个依赖，同时创建需要使用的Controller

<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>

2. 创建一个Swagger类
   最简单的写法

@Configuration
@EnableSwagger2
public class mySwagger {
    @Bean
    public Docket docket(){
        return new Docket(SWAGGER_2);
    }
}

也可以根据自己的需要配置相关的信息

 @Configuration
@EnableSwagger2
public class mySwagger {
    @Bean
    public Docket docket(Environment environment){
        //设置环境，环境一般分为dev开发环境，test测试环境，prod生产环境
        Profiles profiles=Profiles.of("dev","test");
        //判断是否是设置的环境，是则返回true
        boolean noProd= environment.acceptsProfiles(profiles);
        return new Docket(SWAGGER_2)
                .apiInfo(apiInfo())
                //不是生产环境就生成文档
                .enable(noProd)
                .select()
                //只生成这个包下对应的API文档，也可以以其他方式设置
                .apis(RequestHandlerSelectors.basePackage("com.ljh.springbootswagger.Controller"))
                .build()
                ;
    }
    private ApiInfo apiInfo(){
        Contact contact=new Contact("张三", "个人网站地址", "2332762864@qq.com");
        return new ApiInfo("my Documentation",
                "第一个swagger文档",
                "1.0",
                "urn:tos",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
    }
}

①.aips用来配置需要生成Swagger文档的包,不配置默认全部，aips()必须在select()和build()之间
②apiInfo用来配置一些作者或者版本信息，需要传入一个ApiInfo对象，contact表示联系方式
③enable用来开启或关闭生成文档的功能。
上面的environment是来获取开发环境的（一般分为test测试环境，dev开发环境，prod生产环境），上面配置的功能是只有在测试环境和开发环境才生效。
我们可以在properties配置文件中配置环境，如下为dev环境，会生成Swagger文档。

3. 运行结果
只需上面一个类的配置就可以运行得到一个简单的文档了，访问Swagger-ui.html即可查看

主要分为以上四部分
说明：①分组的作用是在多人开发中将每个人写的Controller对应的文档区分开来，比如选择张三分组就只显示张三负责的那部分。当然分组需要进行分组的配置，下面会说到。
②显示的Models不是所有的实体类都显示在这里，是Controller返回值对应有的实体类才会显示，比如我这里返回值为User，Models里就会显示User类的相关信息。

其它常用配置

① 给文档的Model和Comtroller生成一些注释

配置结果：

②添加分组：

结果：

③最后Swagger还有对接口进行测试的功能
结果：