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

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

相关推荐
Cathy Bryant1 天前
矩阵乘以向量?向量乘以向量?
笔记·神经网络·考研·机器学习·数学建模
Lynnxiaowen1 天前
今天我们学习python编程常用模块与面向对象
运维·python·学习·云计算
递归不收敛1 天前
Conda 常用命令汇总(新手入门笔记)
笔记·conda
前端橙一陈1 天前
Salesforce Developer Edition(开发者版) 搭建测试环境
经验分享·笔记·其他
电子小子洋酱1 天前
BearPi小熊派 鸿蒙入门开发笔记(4)
笔记·华为·harmonyos
Han.miracle1 天前
数据结构——排序的学习(一)
java·数据结构·学习·算法·排序算法
摇滚侠1 天前
Spring Boot 3零基础教程,WEB 开发 通过配置类代码方式修改静态资源配置 笔记32
java·spring boot·笔记
电子云与长程纠缠1 天前
Blender入门学习01
学习·blender
qiuiuiu4131 天前
正点原子RK3568学习日志12-注册字符设备
linux·开发语言·单片机·学习·ubuntu
聪明的笨猪猪1 天前
Java JVM “内存(1)”面试清单(含超通俗生活案例与深度理解)
java·经验分享·笔记·面试