1.什么是Swagger2?

Swagger是一个RESTFUL 接口的文档在线自动生成和功能测试的框架。

Swagger 是一个规范和完整的框架。用于生成、描述、调用和可视化RestFul风格的Web服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新文件的方法、参数和模型紧密集成到服务器的代码,允许Api 来始终保持同步,Swagger让部署管理和使用功能强大的Api。

官网:http://swagger.io/

GIthub地址:https://github.com/swagger-api/swagger-ui

2.Swagger2的maven依赖

io.springfox

springfox-swagger2

2.2.2

io.springfox

springfox-swagger-ui

2.2.2

3.SwaggerConfig的配置

12.png

通过@Configuration注解,让SpringBoot来加载该类的配置,再通过@EnableSwagger2注解来启用Swagger2Config。

再通过buildDocket函数创建Docket的Bean之后。buildApiInfo() 用来创建该Api的基本信息(这些信息会展示在文档页面当中)。

select()函数返回一个ApiSelectBuilder实例来控制哪些接口来暴露给swagger2来展示,一般采用指定扫描的包路径来定义。

Swagger会扫描该包下的所有Controller定义的Api,并产生文档内容。(除了被@ApiIgnore指定的请求)。

4,。配置Controller中的Api

下面的内容是基于spring-boot进行配置的,不一定适用于所有的框架,

(1) 下面是常用的一些注解:

@Api: 用在类上,说明该类的作用。

@ApiOperation:用在方法上 ,说明该方法的作用,标注在具体的请求中,value和notes的作用差不多,都是对请求做以说明,tags 则是对请求进行分类的,比如说,你有好几个Controller,分别属于不同的功能模快,那么这里就可以用tags来分类的,

看上去条理性很好

@ApiImplicitParams:用在方法上包含一组参数说明

@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面

paramType:参数放在哪个地方

header 请求参数的获取:@RequestHeader

query 请求参数的获取:@RequestParam

path(用于restful接口) 请求参数的获取:@PathVariable

body(不常用)

form(不常用)

name:参数名

dataType:参数类型

required:参数是否必须传

value:参数的意思

defaultValue:参数的默认值

@ApiResponses:用于表示一组响应

@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息

code:数字,例如400

message:信息,例如"请求参数没填好"

response:抛出异常的类

@ApiModel:描述一个Model的信息(这种一般用在post创建的时候,使用@RequestBody这样的场景,请求参数无法使用@ApiImplicitParam注解进行描述的时候)表明这是一个被swagger框架管理的model,用于class上

@ApiModelProperty 这里顾名思义,描述一个model的属性,就是标注在被标注了@ApiModel的class的属性上,这里的value是对字段的描述,example是取值例子,注意这里的example很有用,对于前后端开发工程师理解文档起到了关键的作用,因为会在api文档页面上显示出这些取值来;这个注解还有一些字段取值,可以自己研究,举例说一个:position,表明字段在model中的顺序。

swagger2maven依赖_swagger2技术相关推荐

  1. swagger2maven依赖_Swagger2安装及使用

    项目开发实现前后端分离,Swagger2是非常好用使用的一个框架!!!真香警告,个人感觉比Postman开发效率提升了很多,注解项会让代码更容易读 在后端开发中经常需要对移动客户端提供RESTful ...

  2. spring依赖注入_Spring依赖注入技术的发展

    spring依赖注入 回顾Spring框架的历史,您会发现在每个发行版中实现依赖注入的方法越来越多. 如果您使用该框架已经超过一个月,那么在这篇回顾性文章中可能不会发现任何有趣的东西. 除了Scala ...

  3. Spring依赖注入技术的发展

    回顾Spring框架的历史,您会发现实现依赖注入的方式在每个发行版中都在增加. 如果您使用该框架已经超过一个月,那么在这篇回顾性文章中可能不会发现任何有趣的东西. 除了Scala中的最后一个示例,没有 ...

  4. 第五节 .NetFramework框架依赖注入技术实现

    .NetFramework框架不提供默认依赖注入容器对依赖注入技术进行实现,如果所开发程序项目是基于.NetFramework框架且这个项目需要使用依赖注入技术进行实现,常用的手段有两种: 1.使用微 ...

  5. VDG值依赖分析技术

    北大软件CoBOT(库博)是具有自主知识产权的静态检测工具.在2013年获得了计算机软件著作权,基于值依赖分析的C程序缺陷静态检测系统.很多同行对值依赖分析的概念可能不是太清楚,今天我们主要分析一下这 ...

  6. docker依赖的技术探索

    参考资料 <自己动手写docker> http://www.sel.zju.edu.cn/?p=556 docker原理探索 docker用于开发应用,交付应用,运行应用的一种开源的软件. ...

  7. 工作中常用到的 Spring 依赖管理技术盘点

    点击关注公众号,实用技术文章及时了解 今天主要和大家分享一些在工作中可能会用到的Spring依赖注入,依赖查找方面的技术点整理,非常实用. Spring依赖查找专题 单一类型查找 常见用法如下所示: ...

  8. swagger2maven依赖_Maven + SpringMVC项目集成Swagger

    Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集成到服 ...

  9. swagger2maven依赖_swagger配置

    1.maven依赖 (第一个后台/v2/api-do,第二个UI页面引用的jar包,版本2.6.1) io.springfox springfox-swagger2 2.6.1 io.springfo ...

最新文章

  1. 7. Query Expressions(查询表达式)
  2. 深度学习入门课程学习笔记06 反向传播
  3. SQL Server 2008编写脚本时智能提示功能丢失的处理
  4. 【数字信号处理】周期序列 ( 正弦序列特性 | 单个模拟周期采集 m 个数字样本 | Q 个模拟周期采集 P 个数字样本 | 非周期序列的情况 | 数字信号周期 )
  5. maven 插件在线安装
  6. 一个本科生,只用了两年就拿下诺贝尔奖,拯救了无数糖尿病患者
  7. java异步线程内存可见性实验
  8. Android 编码规范:(六)消除过期的对象引用
  9. DockerCompose构建Springboot项目
  10. TensorFlow 笔记1 Mac Python环境搭建
  11. webservice采用ssl/https传输
  12. jenkins没有参数化构建过程选项
  13. java基础----集合操作---实例----List集合的初始化
  14. SQL server数据缓存依赖
  15. 【代码技巧】21个经典深度学习句间关系模型
  16. 经典算法归纳(c语言)
  17. 2021FME博客大赛 —— 基于FME的土地利用与夜光遥感数据综合统计
  18. 【茶知识】普洱茶四大茶区的区别特点
  19. 9.后缀、前缀函数-suffix basename addsuffix addprefix
  20. ![CDATA[的web使用简单说明

热门文章

  1. 黄褐斑产生的原因是什么?为什么黑色素只在斑片部位堆积?
  2. Windows系统命令(dos)
  3. CNCF大使宋净超:一万个小时你也可以
  4. 【Electron-vue】构建桌面应用(23)- Error: spawn EACCESS
  5. input禁用判断禁用_如何在索尼电视上禁用运动平滑
  6. 美团点评学龄前儿童营养午餐公益项目落地湖南湘西
  7. 计算机ROM术语,计算机RAM amp; ROM常见词汇
  8. linux必需掌握的基础(二)
  9. GD32移植CoreMark实现性能测评
  10. 2023全国科技工作者日——回顾2023小蛮腰科技大会暨AIGC人工智能峰会,致敬全国科技工作者