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 用在方法上,说明该方法的用途、作用,可以描述接口的详细信息,包括接口名、作用、响应等信息。

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

相关推荐
奶香臭豆腐19 分钟前
C++ —— 模板类具体化
开发语言·c++·学习
波音彬要多做1 小时前
41 stack类与queue类
开发语言·数据结构·c++·学习·算法
m0_748256782 小时前
WebGIS实战开源项目:智慧机场三维可视化(学习笔记)
笔记·学习·开源
红色的山茶花2 小时前
YOLOv9-0.1部分代码阅读笔记-loss.py
笔记
南七澄江3 小时前
各种网站(学习资源及其他)
开发语言·网络·python·深度学习·学习·机器学习·ai
胡西风_foxww4 小时前
【es6复习笔记】Promise对象详解(12)
javascript·笔记·es6·promise·异步·回调·地狱
机智的叉烧9 小时前
前沿重器[57] | sigir24:大模型推荐系统的文本ID对齐学习
人工智能·学习·机器学习
量子-Alex10 小时前
【多模态聚类】用于无标记视频自监督学习的多模态聚类网络
学习·音视频·聚类
吉大一菜鸡10 小时前
FPGA学习(基于小梅哥Xilinx FPGA)学习笔记
笔记·学习·fpga开发
CCSBRIDGE12 小时前
Magento2项目部署笔记
笔记