java插件-Swagger(快速生成接口文档)

本文介绍了如何通过Swagger(Knife4j)在SpringBoot项目中快速生成接口文档,包括引入Maven依赖、配置类中的刀具设置、静态资源映射和注解的使用。

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


博客主页:荔枝点~!
文章说明:Swagger(knfe4j)
本篇内容:通过使用Swagger(knife4j)快速生成生成接口文档


一、概述

在编写代码进行测试时,是不是不想写对应的接口文档,便想快速的进行接口的测试?通过Swagger即可实现!只需要在对应的地方做好相应的配置,然后在需要生成接口文档的地方加上注解,就可以快速的生成注解啦!是不是觉得很nice?这简直是我们懒人码农的福音,话不多说,咱们直接看实现效果。

二、 效果展示

在这里插入图片描述

三、代码实现

1.引入maven坐标

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

2.在配置类中加入knife4j相关配置

@Bean
public Docket docket() {
    ApiInfo apiInfo = new ApiInfoBuilder()
            .title("接口文档")
            .version("2.0")
            .description("接口文档")
            .build();
    Docket docket = new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.sky.controller"))
            .paths(PathSelectors.any())
            .build();
    return docket;
}

3.设置静态资源映射,否则接口文档无法访问(配置文件中)

​ 是对父类方法的重写,通过访问localhost:8080/doc.html可访问生成的接口文档。重写在WebMvcConfiguration extends WebMvcConfigurationSupport类中

protected void addResourceHandlers(ResourceHandlerRegistry registry) {
   
   registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
    registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}

4.常用注解

4.1注解的使用

在需要生成接口文档的类上添加注解

/Api注解,对类进行说明
@Api(tags="员工相关接口")
public class EmployeeController {
    @PostMapping("/login")
//ApiOperation注解 说明方法用途
    @ApiOperation(value="员工登录")
    public Result<EmployeeLoginVO> login(@RequestBody EmployeeLoginDTO employeeLoginDTO) {
    }
    @PostMapping("/logout")
//ApiOperation注解
    @ApiOperation("员工退出")
    public Result<String> logout() {
    }
}
//ApiModel注解
@ApiModel(description = "员工登录时传递的数据模型")
public class EmployeeLoginDTO implements Serializable {
//ApiModelProperty注解
    @ApiModelProperty("用户名")
    private String username;

    @ApiModelProperty("密码")
    private String password;
}

4.2 注解的作用结果

在这里插入图片描述


四、总结

以上就是本次Swagger的操作与实现,总体来说是不是很简单呀,有不懂的可以随时来问我哦,我假如看到会及时私信的,最后,方便点个三连嘛~

评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值