swagger2的配置

swagger2的配置

1.引入对应到jar包

在pom文件中添加swagger2的包，引入相关的依赖，相关的pom文件可以在mvnrepository中搜索相关的包。

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>

    <!--引入视觉的样式的UI-->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>

2.创建swagger2的配置文件

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .useDefaultResponseMessages(false)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                .paths(PathSelectors.any())
                .build();
    }
   private ApiInfo apiInfo() {
    return new ApiInfoBuilder().title("小白系统-小白系统API文档")
            .description(API集合文档")
            .termsOfServiceUrl("http://www.xxx.com")
            .contact(new Contact("小白系统", "http://www.xxx.com",
                    "xxx@qq.com"))
            .version("1.0").build();
	 }
}

3.swagger的基础注解介绍

swagger通过注解生成接口文档，包括接口名、请求方法、参数、返回信息的等等。

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

4.使用swagger的doc文档查看

浏览器输入：

http://localhost:8888/doc.html#/home

5.可通过以上doc测试接口