swagger(API帮助文档)的使用

1.加入依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.9.2</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.9.2</version>
		</dependency>

2.加入配置类

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringBootConfiguration;
import org.springframework.context.annotation.Bean;

import io.swagger.annotations.Api;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@EnableSwagger2
@SpringBootConfiguration
public class AppSwaggerConfig {
	@Value("${swagger2.enable:false}")
	private boolean enable = false;
	@Bean("用户模块")
	public Docket projectApis() {
		return new Docket(DocumentationType.SWAGGER_2).groupName("用户模块").select().apis(RequestHandlerSelectors.withClassAnnotation(Api.class)).paths(PathSelectors.regex("/*.*")).build().apiInfo(apiInfo()).enable(enable);
	}
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder().title("系统平台接口文档").description("提供用户模块的文档").termsOfServiceUrl("http://www.atguigu.com/").version("1.0").build();
	}

}

2.在springboot的application.yml配置文件中加入

swagger2: 
	enable: true

4.使用网站

http://电脑IP:服务器端口号/swagger-ui.html

5.对swagger添加注释：那就百度一下吧！

@Api：修饰整个类，描述Controller的作用
@ApiOperation：描述一个类的一个方法，或者说一个接口
@ApiParam：单个参数描述
@ApiModel：用对象实体来作为入参
@ApiProperty：用对象接实体收参数时，描述对象的一个字段
@ApiResponse：HTTP响应其中1个描述
@ApiResponses：HTTP响应整体描述
@ApiIgnore：使用该注解忽略这个API
@ApiError ：发生错误返回的信息
@ApiImplicitParam：一个请求参数
@ApiImplicitParams： 多个请求参数