Swagger接口文档使用

• 1.Swagger
• 2.Swagger使用
• • 1.添加依赖
  • 2.application.yml配置swagger
  • 2.建立实体类swaggerProperties
  • 3.建立配置类SwaggerConfig
  • 4.需要在WebMvcConfig配置类中设置不拦截
• 3.Swagger注解的使用
• 4.Swagger测试

• API 自动生成同步的在线文档
• 提供 Web 页面在线测试 API

    io.springfox
    springfox-swagger-ui
    2.9.2



    io.springfox
    springfox-swagger2
    2.9.2

#自定义配置
swagger20211010:
  title: 暑假线上班演示RESTful API
  description: 开发人员！
  version: 1.0
  contactName: qcby
  contactEmail:
  contactUrl:
  basePackageRest: com.qcby.shujia.demo.controller 
   #自动扫描的包路径
  termsOfServiceUrl:

@Component
@ConfigurationProperties(prefix = "swagger20211010")  
//要和你配置的名字一样
@Data
public class SwaggerProperties {
    private String title;
    private String contactName;
    private String contactUrl;
    private String contactEmail;
    private String version;
    private String description;
    private String basePackageRest;
    private String termsOfServiceUrl;
}

@Configuration
@EnableSwagger2// 开启Swagger2/接口文档
public class SwaggerConfig {


    @Autowired
    private SwaggerProperties swaggerProperties;

    @Bean
    public Docket createRestApi() {
        return new Docket(documentationType.SWAGGER_2)
                .groupName("REST接口")
                .apiInfo(apiInfo())
                .select()
                //  配置自动扫描那些包下类型生成接口文档
                .apis(RequestHandlerSelectors.basePackage(swaggerProperties.getbasePackageRest()))
                .build();
    }
    //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title(swaggerProperties.getTitle())
                //创建人
                .contact(new Contact(swaggerProperties.getContactName(), swaggerProperties.getContactUrl(),swaggerProperties.getContactEmail()))
                //版本号
                .version(swaggerProperties.getVersion())
                //描述
                .description(swaggerProperties.getDescription())
                .build();
    }
}

// 标识属于一个配置值类  =>  @Component
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 吧登录拦截器注册到spring mvc中
        registry.addInterceptor(loginInterceptor())
                // 该拦截器拦截那些路径？  

// 实体类  
@ApiModel("用户实体")       
// 实体类字段
@ApiModelProperty(value = "创建时间")

直接请求swagger-ui.html