Spring Boot 1.5.8集成Swagger2 + YApi —— Swagger接口信息导入YApi

前言

受新型冠状病毒的影响，在家像猪一样不是睡就是吃，闲着就学着用下Swagger和YApi，特将这几天的学习成果写成了这系列的文章，希望能对大家有所帮助。武汉加油，中国加油！

Spring Boot 1.5.8集成Swagger2 + YApi —— 集成Swagger2
Spring Boot 1.5.8集成Swagger2 + YApi —— Swagger常用注解说明
Spring Boot 1.5.8集成Swagger2 + YApi —— 部署安装mongoDB
Spring Boot 1.5.8集成Swagger2 + YApi —— 部署安装YApi（在线安装）
Spring Boot 1.5.8集成Swagger2 + YApi —— 部署安装YApi（离线安装）
Spring Boot 1.5.8集成Swagger2 + YApi —— swagger接口信息导入YApi

---

现在swagger的接口已经生成好，YApi也已经部署好了，如何将swagger的接口信息导入到YApi，本文将介绍两种导入的方式：

导入接口信息首先要知道导入接口信息的时候的接口数据同步方式，一共有三种同步方式，后面会用到：

• 普通模式(normal)：不导入已存在的接口；
• 智能合并(good)：已存在的接口，将合并返回数据的 response，适用于导入了 swagger 数据，保留对数据结构的改动；例如，用户对字段code 添加了mock信息, 当再次数据导入的时候 mock 字段将不会被覆盖
• 完全覆盖(mergin)：不保留旧数据，完全使用新数据，适用于接口定义完全交给后端定义， 默认为 normal

一、json文件导入的方式

这种方式需要登入到YApi管理平台，稍微麻烦一点

1，导出swagger的接口信息json

登陆访问swagger的接口信息链接：
http://localhost:项目启动端口/项目名/v2/api-docs

浏览器会返回一个json字符串，将该字符串复制下来，并保存为json文件的格式

注意：
保存为json格式的时候，json文件用UTF-8的编码格式进行保存

2，导入json文件

进入YApi项目中的数据管理页面，路径为：

选择项目 > 数据管理 > 数据导入

数据导入页面为：

选择导入刚刚保存的json文件即可。再返回该项目的接口页面，即可看到刚刚导入的接口信息：

再次强调一下，导入的json文件必须是UTF-8的格式，否则中文会乱码！

二、yapi-cli导入

此种方式是通过node安装yapi-cli来进行操作，需要事先安装node才可使用，使用此种方式不需要保存json文件和进入YApi管理平台，效率更高，推荐！

1，安装yapi-cli

安装命令：

npm install -g yapi-cli

如果已经安装了yapi-cli，请确保版本 >= 1.2.7，如果低于此版本，需要升级下yapi-cli

2，新建配置文件yapi-import.json

在本机任一目录新建一个名为yapi-import.json的文件，复制一下内容：

{
     
  "type": "swagger",
  "token": "17fba0027f300248b804hdshdsjfldsjfouiesfwe434i43it409jijkdsjkfjdsfuew",
  "file": "http://localhost:9801/hbs/v2/api-docs",
  "merge": "normal",
  "server": "http://localhost:3000"
}

• type：固定为swagger
• token：你的用户下需要需要上传接口数据的项目的token，可以在YApi管理平台上看到，获取方法下面介绍
• file：token文件的相对或者绝对路径，也可以是url
• merge：合并方式，三种合并方式文章开头有介绍，按照自己需求填写
• server：YApi服务器的部署的地址

token查看方法：
进入YApi管理平台，选择需要上传接口数据的项目，点击 设置 > token配置，即可看到token，如下图所示：

3，运行指令上传

命令行进入刚刚创建yapi-import.json的文件夹，在该路径下运行命令：

yapi import

上传完成：

以后开发，每次更新swagger的接口信息后，只需要进入yapi-import.json文件所在的路径，运行下yapi import指令就可以更新YApi平台上的接口信息啦，十分方便