2.12 SwaggerP14

Swagger介绍

使用Swagger只需要按照规范去定义接口及接口相关的信息，就可以做到生成接口文档，以及在线接口调试页面。Swagger可以帮助后端生成接口文档、进行在线接口测试。

Knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案。

导入下面坐标：

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-starter</artifactId>
    <version>3.0.2</version>
</dependency>

 相关配置：

@Bean
    public Docket docket() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("苍穹外卖项目接口文档")
                .version("2.0")
                .description("苍穹外卖项目接口文档")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.sky.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

它会扫描controller里面的所有方法，然后通过反射去解析，最终生成接口文档。

设置静态资源映射：

protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}

启动后访问localhost:8080/doc.html即可：

有login和logout这些都是controller里的方法：

可以直接在页面的测试栏中对方法进行测试：

@Api注解使用样例（记得要加tags=）：

@ApiModel注解使用样例：

@ApiModelProperty注解使用样例：

@ApiOperation注解使用样例：

 注解影响如下图：