Swagger --学习笔记

什么是Swagger?

Swagger是API设计工具集,用于帮助开发者设计、构建和文档化RESTful Web服务。它通过标准化的格式来描述API接口,使得创建、维护和使用API变得更加清晰和简便,同时提供工具支持API的交互式文档、编辑器以及代码的自动生成

Spring已经将Swagger纳入自身的标准,建立了Spring-swagger项目,现在叫Springfox。通过在项目中引入Springfox ,即可非常简单快捷的使用Swagger

nife4j是为Java生态下的Swagger增强解决方案,目标是在Swagger的基础功能上,提供更加人性化的API文档呈现形式,取名kni4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!

如何使用

1、导入

在pom.xml中添加knife4j 的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("版本")
                .contact(new Contact("作者","作者网站","作者邮箱"))
                .description("描述")
                .build();
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("生成接口需要扫描的包"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

3、在配置类设置静态资源映射,否则接口文档页面无法访问

复制代码
/**
     * 设置静态资源映射
     * @param registry
*/
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}

基本配置完成,启动服务后,通过 http://localhost:8080/doc.html 路径即可访问接口文档

Swagger常用注解

注解 说明
@Api 用在控制层类(Controller)上,表示对类的说明,可用于分组(tags属性)、描述(description属性)等。
@ApiModel 用在实体类(Entity)、数据传输对象(DTO)、值对象(VO)上,用来描述一个模型的信息,比如在生成的文档中说明这个模型是做什么用的。
@ApiModelProperty 用在属性上,描述属性的信息,例如数据类型、参数说明、是否必需等。
@ApiOperation 用在方法上,说明该方法的用途、作用,可以描述接口的详细信息,包括接口名、作用、响应等信息。

通过这些注解配置的说明将会同步到接口文档中

相关推荐
数字芯片实验室5 小时前
分享一个可以学习正则表达式的网址:Pythex.org
学习·正则表达式
陈洪奇6 小时前
注册中心学习笔记整理
笔记·学习
光影少年6 小时前
从前端转go开发的学习路线
前端·学习·golang
兴趣使然_9 小时前
【笔记】使用 html 创建网址快捷方式
笔记·html·js
aramae10 小时前
C++ -- STL -- vector
开发语言·c++·笔记·后端·visual studio
fen_fen11 小时前
学习笔记(32):matplotlib绘制简单图表-数据分布图
笔记·学习·matplotlib
饕餮争锋15 小时前
设计模式笔记_创建型_建造者模式
笔记·设计模式·建造者模式
萝卜青今天也要开心15 小时前
2025年上半年软件设计师考后分享
笔记·学习
amazinging15 小时前
北京-4年功能测试2年空窗-报培训班学测开-第四十七天
python·学习·selenium
吃货界的硬件攻城狮16 小时前
【STM32 学习笔记】SPI通信协议
笔记·stm32·学习