Spring Boot集成Swagger导入YApi@无界编程
接口APi开发现状
现在开发接口都要在类似YApi上写文档,这样方便不同的团队之间协作,同步更新接口,提高效率。
但是如果接口很多,你一个个手工在YApi去录入无疑效率很低。
如果是使用Spring Boot集成Swagger可以直接导入YApi非常方便,不过还有一些需要注意的事项。
1.Spring Boot集成Swagger
添加swagger相关的maven依赖
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version>
</dependency>
2.添加swagger的配置类
@Configuration
@EnableSwagger2
@ComponentScan(basePackages = { "xxx.controller" })//扫描的包路径
public class SwaggerConfig {@Beanpublic Docket api() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().paths(PathSelectors.any()).build();}/*** 该套 API 说明,包含作者、简介、版本、host、服务URL* @return*/private ApiInfo apiInfo() {return new ApiInfoBuilder().title("api 说明")//接口标题.description("商品列表接口")//接口描述.version("v1.0")//版本号.contact(new Contact("name", "url", "email"))//联系人信息.build();}
}
或者
@Configuration
@EnableSwagger2
public class SwaggerConfig {@Beanpublic Docket api() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage("xxx.controller")) //扫描的包路径.build();}/*** 该套 API 说明,包含作者、简介、版本、host、服务URL* @return*/private ApiInfo apiInfo() {return new ApiInfoBuilder().title("api 说明").contact(new Contact("allen","null","name@example.com")).version("0.1").termsOfServiceUrl("localhost:8080/demo/").description("demo api").build();}}
3.使用Swagger注解
@Api()用于类;
标识这个类是swagger的资源
tags–表示分组说明标签
@ApiOperation()用于方法;
表示一个http请求的操作
value用于方法描述
notes用于提示内容
@ApiModel()用于实体类
表示对类进行说明,用于参数用实体类接收
value–表示对象名
description–描述
@ApiModelProperty()用于实体类字段
表示对model属性的说明或者数据操作更改
value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏
@ApiImplicitParam() 用于 controller 方法
表示单独的请求参数
name–参数ming
value–参数说明
dataType–数据类型
paramType–参数类型
example–举例说明
@ApiImplicitParams() 用于 controller 方法,包含多个 @ApiImplicitParam
@ApiIgnore()用于类或者方法上,可以不被swagger显示在页面上
说明:简单的标记只需要@Api(tags="") 和 @ApiOperation(value="",notes="")
更多参考:https://github.com/swagger-api/swagger-core/wiki/Annotations
4.Java代码写上Swagger注解
@Api(tags = "xxx查询列表Api")
@RestController
@RequestMapping(value = {"/xx/"}, produces = {MediaType.APPLICATION_JSON_VALUE})
public class xxxApiController {@GetMapping("/xxx/getAllList")*/@ApiOperation("xxxx-查询列表")@PostMapping(value = {"/xxx/getList", "/front/getCount"}
5.查看Swagger UI
随着你系统的URL路径不同而不同,默认在这
http://localhost:8080/swagger-ui.html
如果你有服务的前缀xxx-service加上即可
http://localhost:8080/xxx-service/swagger-ui.html
查看某一个controller下的接口列表:
查看某个具体接口:
返回值
至此swagger的任务已经完成。
6.swagger导入YApi
swagger ui显然看起来还是不方便,目前很多公司都在用YApi做接口的标准文档管理了。
YAPI里点 数据管理 ,然后导入swagger的json数据即可。
注意这里YAPI号称支持导入swagger的URL,发现不好用,导入不进来。
回到swagger的UI界面
点这个链接,打开复制数据存为xxx.json即可,如果存txt也许会乱码
导入yapi即可
在Ypai里看起来是不是清爽很多:
相关文章:
【MATLAB】数据分析之函数数值积分
一、数值积分问题的数学表达 称为积分节点,称为求积系数。右端公式称为左端定积分的某个数值积分。MATLAB支持三重以下的积分运算。分别为: 在计算积分时,要求积分区间是确定的。 二、一元函数的数值积分 1、quad函数:采用遍历的…

c++对象切片
什么事对象切片:c在将一个派生类转换为基类的过程中,派生类的一部分将被基类接收不到,只能留下基类大小的对象。传值调用的切片:#include<iostream> using namespace std; class Base { public: virtual void func1() { cou…

javascript数据结构与算法-队列
定义 队列是一种特殊的线性表,特殊之处在于它只允许在表的前端(front)进行删除操作,而在表的后端(rear)进行插入操作,和栈一样,队列是一种操作受限制的线性表。进行插入操作的端称为…

Oracle学习笔记十三 触发器
2019独角兽企业重金招聘Python工程师标准>>> 简介 触发器是当特定事件出现时自动执行的存储过程,特定事件可以是执行更新的DML语句和DDL语句,触发器不能被显式调用。 触发器的功能: 1.自动生成数据 2.自定义复杂的安全权限 3.提供…

使用Notepad++比较文件的差异
有时候需要比较两个文件的差异部分,如果不在git里可以使用Notepad的插件。 在Notepad中安装Compare插件 打开NotePad,点击工具栏上的插件--Plugin Manager--Show Plugin Manager,选中Compare 然后安装。 比如下看两个线程堆栈的差异…
【MATLAB】将向量表示的多项式用字符串输出的通用函数示例
%创建一个名为pprintf的M文件 function s pprintf(p) %UNTITLED7 此处显示有关此函数的摘要 % 此处显示详细说明 if nargin>1error(Too much input arguments); end while(p(1)0)p1[]; end llength(p); if l0s0; elseif l1snum2str(p(1)); elseif l2s strcat(num2str(p(…

30秒或更短的时间内弄懂的有用CSS代码片段
今天无意间看到这个,真的很牛逼,记录下中文网: caibaojian.com/30-seconds-…转载于:https://juejin.im/post/5bf278a85188255e9b61a226
【MATLAB】数据分析之多项式及其函数
1、多项式的表达式和创建 MATLAB中使用一维向量来表示多项式。将多项式按照降幂次序存放在向量中。 多项式就可以用向量 [2 3 5 0 1]来表示。 2、多项式求根 >> p[1 2 1]p 1 2 1>> r roots(p)r -1-13、由根创建多项式 >> r [2;3]r 23>>…

SpringBoot自定义异常源码分析
SpringBoot自定义异常源码分析 在类上加ControllerAdvice注解,在方法上加ExceptionHandler注解,就可以在方法里处理相应的异常。 1.自定义异常处理类AdditionalExceptionHandler 挂RestControllerAdvice注解: ------------------ 2.自定义…

Android 应用性能优化-StrictMode(严格模式)
为什么80%的码农都做不了架构师?>>> UI线程如果被阻塞5秒的话,那么应用程序此时就会弹出ANR的对话框,ANR对应用程序来说是一个很严重的问题。 如何防止应用程序出现ANR,怎么分析查看导致ANR问题的原因? 我…

跨进程通信,到底用长连接还是短连接
一个完整的软件系统大多数情况下是由多个进程共同协作进行的,哪怕它们在同一台服务器上。所以,进程之间如何进行高效的通信至关重要。 单个应用程序单个数据库这套基础开发套餐我相信每个人都经历过,甚至在初期它们还有可能部署在同一台服务器…

Java的List和Json转换以及StringRedisTemplate往redis存泛型对象
List转Json List<User> user new ArrayList(); String str JSON.toJSONString(user); Json 转List方法一 List<User> user JSON.parseArray(json,User.class); 如果是泛型方法需要使用TypeReference Json 转List 方法二 String json "[{}]"; Li…

【MATLAB】符号数学计算(一):符号对象的创建
一、符号对象的创建命令 1、函数命令sym( ) variablesym(A,flag)Ssym(A,flag) 如果A是(不带单引号)是一个数字、数值矩阵或者数值表达式,则输出结果是将数值对象转换成的符号对象。 如果A(带单引号)是一个字符串,输出结果则是将字符串转换成的符号对象…
分布式session一致性问题
传统的网站结构(并发量不大,没有session的不一致的问题。传统的网站结构图: **结论:**从图中可以看出在传统的网站结构中,所有的客户端都连接一个服务器,每个客户端发送过来的请求都被该服务器处理&#…

切换阿里云maven源解决maven中央仓库下载太慢卡顿的问题
maven默认官方的中央仓库有时候很慢下载jar甚至会卡住,那么你可以切换到阿里云的maven源 在本地的maven文件夹新建settings.xml <?xml version"1.0" encoding"UTF-8"?> <settings xmlns"http://maven.apache.org/SETTINGS/1.…

【MATLAB】符号数学计算(二):符号运算中的运算符和函数
一般的这里就不再列举 1、算术运算符号 运算符号“ ”、“ . ”分别实现矩阵的共轭转置和非共轭转置。 >> syms a b c d; >> Asym([a,b;c,d])A [ a, b] [ c, d]>> R1AR1 [ conj(a), conj(c)] [ conj(b), conj(d)]>> R2A.R2 [ a, c] [ b, d] 2、关…

2015级C++第14周实践项目 模板
【项目1-排序函数模板】 已知 void Sort(int a[],int size); void Sort(double a[],int size); 是一个函数模板的两个实例,其功能是将数组a中的前size个元素按从小到大顺序排列。试设计这个函数模板。 【项目2-两个成员的类模板】 设有如下的类声明&#…

11月18日珠三角城市人口迁徙可视化(和弦图)
2019独角兽企业重金招聘Python工程师标准>>> 一、导入数据,初始图 > library(circlize) > data<-read.table("C:/Users/cuiy/Desktop/PersonalData/qianxi.csv",sep",",headerT) > head(data)from to value 1 中山 珠…

【MATLAB】符号数学计算(三):符号的精度计算
符号计算的一个非常显著的特点是,由于计算中不会出现舍入误差,从而可以得到任意精度的数值解。 (要计算精确,就要牺牲计算时间和储存空间) 符号工具箱中有三种不同类型的算术运算: 数值类型:…

SQLite第三方框架FMDB的使用,以及使用FMDatabaseQueue保证线程安全
2019独角兽企业重金招聘Python工程师标准>>> (1)下载地址:https://github.com/ccgus/fmdb (2)注意点 ——语句可以带分号“;”,也可以省略分号。 ——同样需要添加“libsqlite3.dyli…

Linus采访对Linux对git和对代码品味的理解
【Linus对办公环境的要求】 Linus大师说他11岁就开始编程,他说他是一个喜欢安静和不合群的人。 图中是他和他的弟弟,看来少儿编程还是很重要的,大师21岁写出linux0.0.1最初的内核。 图中是他的家,也是Linux的总部,非常简单的办公环境,只有显示器,大师喜欢安静,所以不想…

04 集成学习 - Boosting - AdaBoost算法构建
03 集成学习 - Boosting - AdaBoost算法原理 十、AdaBoost算法构建 上一章最后说明了每个基模型的权值α是如何求得的,于是我就可以对模型进行更新操作了。 构建过程一 1、假设数据集: T{(X1,Y1),(X2,Y2),...(Xn,Yn)} 2、初始化训练数据权重分布…

Redis源码分析 List实现
在版本3.2之前,Redis中的列表是 ziplist 和 linkedlist 实现的,在3.2之后,由quicklist实现。 双向链表linkedlist在表的两端进行push和pop操作非常方便,但是地址不连续,而且需要保持额外的指针。 ziplist是连续内存&am…

Linux cut命令
用途 文本文件按列提取。 特点 过于简单,只能处理固定格式的分隔符,分隔符不能使用正则表达式。 用法 命令基本格式 -b、-c、-f分别表示字节、字符、字段(即byte、character、field);list表示-b、-c、-f操作范围&#…

【MATLAB】符号数学计算(四):符号表达式操作
一、符号表达式合并 Rcollect(S):将表达式S中相同次幂的项合并。S可以是一个表达式,也可以是一个符号矩阵。Rcollect(S,v):将表达式中S中v的相同次幂进行合并。如果v没有指定,则默认将含有x的相同次幂的项进行合并。 >> sy…

Alpha冲刺——day1
Alpha冲刺——day1 作业链接 Alpha冲刺随笔集 github地址 站立式会议 会议安排:alpha冲刺的第一天,我们站立式会议讨论了我们接下来的安排,做出大致的规划,并针对之前的原型设计,讨论了界面设计的大概 项目进展项目进展…

一步一步学习VirtualBox安装CentOS7和CentOS8
个人学习研究Linux推荐安装VirtualBoxCentOS。 CentOS7和CentOS8的安装实际上是非常相似的,改变的地方不多,从CentOS7开始和CentOS6相比改变是非常大的。 VirtualBox本身是免费的,足够正常学习应用了,安装CentOS是因为企业线上大…

建模原语:四象图
原文地址:http://www.douban.com/note/164191021/ “模型、状态和行为特征、场景”和“四象图”,建模观的命名与立象。 建模原语:四象图 作者:achieveideagmail.com 命名:模型、结构特征、行为特征、场景(及其规约&…

【MATLAB】符号数学计算(五):符号函数的替换
一、subs替换函数 Rsubs(S):用工作区中的变量值替换符号表达式中的某一特定符号。Rsubs(S,New):用新符号变量New来替换符号表达式S中的默认变量。Rsubs(S,Old,New) >> syms x y >> fsym(x^2x*yy^2)f x^2 x*y y^2>> x2; >> su…

Ubuntu阿里云搭建Mono.net环境
查看磁盘信息 我们买的系统默认情况下只是安装了系统,而数据盘需要自己挂载,例如我这里的系统占用20多G,还有40多G的数据盘默认是没有挂载的,首先我们运行df -h查看: rootAY1212241134392134698:~# df -hFilesystem Si…