swagger的使用

本文介绍了如何在SpringBoot项目中集成Swagger,包括添加knife4j-spring-boot-starter依赖,配置Swagger接口文档,设置静态资源映射,以及在Controller层的使用方法,以便于生成API文档并提供访问。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1、添加依赖坐标

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

2、修改swagger的配置,在配置类中加入

@Bean
    public Docket docket() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("标题")
                .version("版本号")
                .description("描述")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("需要扫描的包的路径"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

3、设置静态资源映射(同样是在配置类中)

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页面,即可打开swagger的客户端

4、对实体类

5、在controller层的使用

大体的使用就是这样的了

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值