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 相关配置

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

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

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/pingmian/12578.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

深入理解JVM:介绍JVM的工作原理,包括类加载机制,内存模型,垃圾回收机制等

类加载机制&#xff1a; JVM的类加载机制主要包括加载、连接&#xff08;验证、准备和解析&#xff09;、初始化、使用和卸载五个阶段。第一个阶段是加载需求的.class文件到内存中。第二个阶段是完成对字节码的验证&#xff0c;为类变量分配内存并初始化为对应类型默认值。第三…

别再找了!吐血整理ChatGPT 3.5/4.0新手使用手册

引领科技潮流的ChatGPT早已名声在外&#xff0c;如今获取ChatGPT已变得触手可及&#xff0c;但很多人还多次提问如何使用chatgpt&#xff0c;为了避免陷入误区&#xff0c;本文旨在为广大ChatGPT爱好者提供一份实用的指南。 因此&#xff0c;帮助大家更好地掌握其使用技巧&…

python的字典学习笔记

来自WeTab AI PRO 1.两个元素数量相同的元组&#xff0c;将其中一个元组的每个元素作为键&#xff0c;将另一个元组的每个元素作为值&#xff0c;生成字典 要根据两个元素数量相同的元组生成字典&#xff0c;其中一个元组的每个元素作为键&#xff0c;另一个元组的每个元素作…

leetcode.环形链表问题

目录 题目1 示例 解题思路 代码实现 补充 题目2 示例 解题思路 代码实现 题目1 该题链接&#xff1a;https://leetcode.cn/problems/linked-list-cycle/description/ 示例 解题思路 要创建两个指针一个是快指针(fast)&#xff0c;另一个慢指针(slow)。快指针走两步慢指…

Linux修改终端命令颜色

1.在家目录中修改.bashrc文件 cd ~ vim .bashrc2.找到PS1相关段落&#xff0c;把其他的注释掉&#xff0c;填上该行代码&#xff0c;修改为自己设置的颜色 (具体颜色查看参考文章) 提供两种颜色&#xff0c;其他的自学调色盘吧(下文有)~ (祝你愉快) ①浅蓝色 深蓝 PS1\[\03…

华医网在线教育系统,经过疫情,知识付费行业的机遇!

因为知识付费的行业入门门槛很低&#xff0c;所以产品的质量也参差不齐&#xff0c;因为疫情的影响&#xff0c;知识付费行业迎来了一波机遇。 因为知识付费门槛低&#xff0c;所以持续创造优质内容才是王道&#xff1b;现在成熟的知识付费平台和产品受到了大部分用户的喜欢&am…

WebLogic Serer的服务策略

服务策略 Oracle提供终身服务策略。以下按照服务级别,分别说明了各级别的服务期间以及服务内容。 Premier Support 服务期间 制品出荷~开始后的第5年 服务内容 提供程序的更新版提供新做成的补丁提供安全情报提供Critical Patch Update税务法律合规提供升级脚本大多数新产…

CSRF 攻击实验:Token 不存在绕过验证

前言 CSRF&#xff08;Cross-Site Request Forgery&#xff09;&#xff0c;也称为XSRF&#xff0c;是一种安全漏洞&#xff0c;攻击者通过欺骗用户在受信任网站上执行非自愿的操作&#xff0c;以实现未经授权的请求。 CSRF攻击利用了网站对用户提交的请求缺乏充分验证和防范…

基于Java+SpringBoot+vue+elementui 实现猜灯谜答题抽奖系统

目录 系统简介效果图1、手机答题端2、后台系统管理 源码结构源码下载地址技术交流 博主介绍&#xff1a; 计算机科班人&#xff0c;全栈工程师&#xff0c;掌握C、C#、Java、Python、Android等主流编程语言&#xff0c;同时也熟练掌握mysql、oracle、sqlserver等主流数据库&…

2024年成都市首台(套)重大技术装备示范申报奖励补助、要求

一、支持市场推广应用 &#xff08;一&#xff09;出台市级认定管理办法。出台市级首台&#xff08;套&#xff09;产品认定管理办法&#xff0c;开展市级首台&#xff08;套&#xff09;产品目录征集、产品认定&#xff0c;并会同物价部门、研制单位、应用单位共同就首台&…

MES系统在电线电缆行业生产上的应用

MES系统在线缆行业的应用可以带来多重价值&#xff0c;包括提高生产效率、降低生产成本、提高产品质量、优化库存管理、改善生产环境和提高企业竞争力等方面。因此&#xff0c;在电线电缆行业中广泛应用MES系统可以提高企业的经济效益和社会效益&#xff0c;推动企业发展和行业…

封装的艺术:探索面向对象编程的核心守护神

1. 概述 封装是面向对象编程&#xff08;OOP&#xff09;的三大核心特性之一&#xff0c;它是指将对象的属性和方法结合成一个独立的单元&#xff0c;并将这个单元的内部实现细节隐藏起来&#xff0c;只对外提供公共的访问方式。封装的目标是提高代码的安全性、可维护性和复用…

第1章 初始Spring Boot【仿牛客网社区论坛项目】

第1章 初始Spring Boot【仿牛客网社区论坛项目】 前言推荐项目总结第1章初识Spring Boot&#xff0c;开发社区首页1.课程介绍2.搭建开发环境3.Spring入门体验IOC容器体验Bean的生命周期体验配置类体验依赖注入体验三层架构 4.SpringMVC入门配置体验响应数据体验响应Get请求体验…

【项目汇报中的 STAR 法则】项目管理必会的思维分析工具13

STAR法则是《高效培训》一书中所提出的概念&#xff0c;是结构化的一个重要理论&#xff0c;即Situation&#xff08;情景&#xff09;、Task&#xff08;任务&#xff09;、Action&#xff08;行动&#xff09;和Result&#xff08;结果&#xff09;。 1.Situation&#xff0…

绝地求生:一穿四教学,绿色玩家也能轻松一穿四

PUBG一穿四速成班开课啦&#xff01;我这里只做PUBG干货分享&#xff0c;不搬运&#xff01;不搬运&#xff01;&#xff01;不搬运&#xff01;&#xff01;&#xff01; 有很多朋友是否在排位里kd不高&#xff0c;开局不是扎堆roll点就是一直搜东西然后一波就没&#xff1f;这…

更换冷冻油的知识介绍

一、 冷冻油更换的条件 1、 空调机组长时间工作&#xff0c;压缩机已达到保养时限&#xff08;机组初次运行2000小时、之后运行累计三年或运行时间超过10000&#xff5e;12000小时&#xff09;&#xff1b; 2、 因电机烧毁而更换压缩机&#xff1b;更换压机后连续运行100小时…

机器视觉中的打光技巧、选择光源的流程

目录 基本原则选择照明的考虑因素明场照明和暗场照明全明场照明&#xff08;漫射照明&#xff09;技术 特定光源1. 环形光源2. 条形光源3. 同轴光源3.1 何时使用同轴照明&#xff1f;3.2 何时不使用同轴照明&#xff1f; 4. 背光源5. 远心照明6. 点光源7. 穹顶光源8. 线光源9. …

3、架构-事务处理

目录 概述 场景事例 本地事务 实现原子性和持久性 实现隔离性 概述 事务处理几乎在每一个信息系统中都会涉及&#xff0c;它存在的意义是为 了保证系统中所有的数据都是符合期望的&#xff0c;且相互关联的数据之间不 会产生矛盾&#xff0c;即数据状态的一致性&#xff0…

使用Git命令从本地上传到码云

最近刚接触Git和码云&#xff0c;想着把本地代码上传到码云上供大家借鉴&#xff0c;但困难的是一直没有解决如何上传的问题。仔细摸索了几天&#xff0c;找到了一点途径&#xff0c;请大家帮忙指点一二~ Gitee创建仓库内没有内容 本地&#xff1a; 初始化Git仓库&#xff1…

python日志解析生成excel表

需求 实时流媒体性能指标分析&#xff0c;提升问题定位效率 方案 日志文件读取解析&#xff1a;python excel表生成&#xff1a;xls 实现 未完待续