Swagger2的简单介绍和使用

1.Swagger2是什么？

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

2.Swagger2的特点是什么？

（1） 及时性 (接口变更后，能够及时准确地通知相关前后端开发人员)
（2）规范性 (并且保证接口的规范性，如接口的地址，请求方式，参数及响应格式和错误信息)
（3）一致性 (接口信息一致，不会出现因开发人员拿到的文档版本不一致，而出现分歧)
（4）可测性 (直接在接口文档上进行测试，以方便理解业务

3、Swagger2的快速使用

（1）.创建普通springboot项目并引入相关依赖.当然也可以创建maven再变成springboothttps://blog.csdn.net/weixin_46258873/article/details/114680250

 <!--swagger-->
 <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger2</artifactId>
       <version>2.4.0</version>
       <scope>provided </scope>
</dependency>
<dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger-ui</artifactId>
       <version>2.4.0</version>
       <scope>provided </scope>
</dependency>

(2)创建包com.chang.config，创建类SwaggerConfig

package com.chang.config;

import com.google.common.base.Predicates;
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.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 SwaggerConfig {
    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();
    }

    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("网站-课程中心API文档")
                .description("本文档描述了课程中心微服务接口定义")
                .version("1.0")
                .contact(new Contact("Helen", "http://chang.com", "55317332@qq.com"))
                .build();
    }
}

注意：不使用@EnableSwagger2注解会报以下错误

(3)在我们要使用swagger的其它工程中导入上面工程的依赖。如

 <dependencies>
        <dependency>
            <groupId>com.chang</groupId>
            <artifactId>service-base</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
 </dependencies>

(4)在我们要使用swagger的其它工程中的启动类上添加注解，进行测试，访问路径如下：http://localhost:8001/swagger-ui.html

@SpringBootApplication
@EnableSwagger2
@ComponentScan("com.chang")//swagger2所在的部分包名
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class,args);
    }
}

（5）可忽略这一步，定义接口说明和参数说明
定义在类上：@Api
定义在方法上：@ApiOperation
定义在参数上：@ApiParam

@Api(description="讲师管理")
@RestController
@RequestMapping("/eduService/teacher")
public class TeacherController {

    @Autowired
    private TeacherService teacherService;

    @GetMapping("/findAll")
    @ApiOperation(value = "所有讲师列表")
    public  List<Teacher> findAllTeacher(){
        return  teacherService.list(null);
    }
    @ApiOperation(value = "根据ID删除讲师")
    @DeleteMapping("/{id}")
    public boolean deleteById(
            @ApiParam(name = "id", value = "讲师ID", required = true)
            @PathVariable String id){
        return teacherService.removeById(id);
    }
}

常见问题https://zhaoxuyang.com/springboot%E4%BD%BF%E7%94%A8swagger2%E5%87%BA%E7%8E%B0unable-to-infer-base-url-this-is-common-when-using-dynamic-servlet-registration-or-when-the-api-is-behind-an-api-gateway/