Swagger

• 介绍
• 作用
• Swagger常用注解
• 例如
• 代码

介绍

• Spring Boot 可以集成Swagger，生成Swagger接口，Spring Boot是Java领域的神器，它是Spring项目下快速构建
  项目的框架。

作用

• 在网页上测试接口

Swagger常用注解

• 在Java类中添加Swagger的注解即可生成Swagger接口，常用Swagger注解如下：

1. @Api：修饰整个类，描述Controller的作用
2. @ApiOperation：描述一个类的一个方法，或者说一个接口
3. @ApiParam：单个参数描述
4. @ApiModel：用对象来接收参数
5. @ApiModelProperty：用对象接收参数时，描述对
   象的一个字段
6. @ApiResponse：HTTP响应其中1个描述
7. @ApiResponses：HTTP响应整体描述
8. @ApiIgnore：使用该注解忽略这个API
9. @ApiError ：发生错误返回的信息
10. @ApiImplicitParam：一个请求参数
11. @ApiImplicitParams：多个请求参数
    @ApiImplicitParam属性：
    

例如

代码

http://localhost:8080/swagger-ui.html

@Configuration
@EnableSwagger2
public class Swagger2Configuration {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.")) //controller包
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("demo")
                .description("demo")
//                .termsOfServiceUrl("/")
                .version("1.0")
                .build();
    }

}