配置swagger的配置类模板

该博客展示了如何在Java项目中配置Springfox库,以利用Swagger2创建REST API的详细文档。通过`SwaggerConfig`类,作者定义了API的基本信息,包括联系人、标题、描述和版本。配置还包括了API的扫描包路径和访问路径选择器,确保文档覆盖了指定的控制器路径。
摘要由CSDN通过智能技术生成
package nuc.eduservice.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.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;


@Configuration
public class SwaggerConfig {
    @Bean
    public Docket Docket(){
        //指定springfox里用swagger2
        Docket docket = new Docket(DocumentationType.SWAGGER_2);

        ApiInfo apiInfo = new ApiInfoBuilder()
                .contact(
                        //用于编写文档基本信息
                        new Contact(
                                "中北大学软件学院",
                                "http://ss.nuc.edu.cn/",
                                "19130415641@nuc.edu.cn")
                )
                .title("swagger-ui文档")
                .description("描述内容")
                .version("1.2")
                .build();
        docket.apiInfo(apiInfo);

        //构建选择器
        docket.select()
                //扫描文件路径
                .apis(RequestHandlerSelectors.basePackage("nuc.eduservice.controller")
                )
                //用于用于指定访问路径
                .paths(
                        Predicates.or(
                                PathSelectors.regex("/swagger/.*"),
                                PathSelectors.regex("/.*")
                        )
                )
                .build();
    return docket;
    }
}

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值