Swagger使用

Posted 2020-12-24 wccw

@

目录

• 1、添加knife4j依赖
• 2、配置类Swagger2Config.java
• 3、基本使用
• 4、访问效果

spring boot + swagger

这里用的是knife4j

1、添加knife4j依赖

只需添加下面一段即可，自动引入其他相关依赖

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

2、配置类Swagger2Config.java

package com.wwwc.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)//swagger版本
                .apiInfo(apiInfo())//定义api文档汇总信息
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.wwwc.controller"))//指定生成api文档的包
                .paths(PathSelectors.any())//指定所有路径
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API接口文档")
                .contact(new Contact("ccw","http://cwccw.github.io","[e-mail]"))//联系人信息
                .description("spring boot demo的API接口文档")//描述
                .termsOfServiceUrl("http://localhost:80/")//网站地址
                .version("1.0")//文档版本号
                .build();
    }
}

3、基本使用

1、在Controller类上添加，标注一个分类信息
@Api(tags = "测试类TestController")
2、在请求类上添加，标注一个接口信息
@ApiOperation(value = "返回列表数据",notes = "根据两个参数返回其范围内的数据")
3、其余自行扩展，这里只讲基本使用

4、访问效果

启动项目，输入访问 项目url/doc.html 即可。