当前位置：首页 > 科技 > 软件

只会使用Swagger？不妨试试YApi进行接口文档管理

来源：责编：时间：2023-08-09 23:02:22 213观看

导读一、前言在我们后端开发中，必不可少的是接口的交接，有很多种方式，常见的就是swagger，不过这个侵入性太强了。还有就是接口文档的框架，比如今天小编带大家一起搭建的yapi，在公司还是挺常见的！今天小编就大家从搭建到使用，详细

一、前言

在我们后端开发中，必不可少的是接口的交接，有很多种方式，常见的就是swagger，不过这个侵入性太强了。还有就是接口文档的框架，比如今天小编带大家一起搭建的yapi，在公司还是挺常见的！今天小编就大家从搭建到使用，详细的教学一波哈！

二、介绍

1、平台介绍

YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

2、特性

基于 Json5 和 Mockjs 定义接口返回数据的结构和文档，效率提升多倍。
扁平化权限设计，即保证了大型企业级项目的管理，又保证了易用性。
类似 postman 的接口调试。
自动化测试, 支持对 Response 断言。
MockServer 除支持普通的随机 mock 外，还增加了 Mock 期望功能，根据设置的请求过滤规则，返回- - 期望数据。
支持 postman, har, swagger 数据导入。
免费开源，内网部署，信息再也不怕泄露了。

3、环境支持

nodejs（7.6+)
mongodb（2.6+）
git

在docker中只需要搭建一下mongo，用来数据的存储即可！

三、运行mongo

1、创建网络

docker network create yapi

2、创建挂载文件

mkdir -p /data/mongo

3、运行mongo

docker run -d /  --name mongodb /  --restart always /  --net=yapi /  -p 27017:27017 /  -v /data/mongo:/data/db /  -e MONGO_INITDB_DATABASE=yapi /  -e MONGO_INITDB_ROOT_USERNAME=yapi /  -e MONGO_INITDB_ROOT_PASSWORD=yapi /  mongo

启动 MongoDB，其中 -e 指定 MONGO_INITDB_ROOT_USERNAME 为 MongoDB 的 ROOT 用户名，MONGO_INITDB_ROOT_PASSWORD 为 MongoDB 的 ROOT 用户密码。

4、进入容器初始化数据库

进入 MongoDB 容器，从上图查看 MongoDB 容器可以获取到容器 id，以下示例使用 50f1f6c50139代表 MongoDB 的容器 id，只需要简写即可！

docker exec -it 50 /bin/bash

接着输入：

mongosh

「新版本需要加上sh，不然无法进入！」

use admin;db.auth("yapi", "yapi");# 创建 yapi 数据库use yapi;# 创建给 yapi 使用的账号和密码，限制权限db.createUser({  user: 'yapi',  pwd: 'yapi',  roles: [ { role: "dbAdmin", db: "yapi" }, { role: "readWrite", db: "yapi" }  ]});# 退出 Mongo Cliexit# 退出容器Ctrl+P+Q

四、运行yapi

1、搭建挂载配置文件

mkdir -p /data/yapi

vim config.json

{   "port": "3000",   "adminAccount": "wangzhenjun1221@163.com",   "timeout":120000,   "db": {     "servername": "mongo",     "DATABASE": "yapi",     "port": 27017,     "user": "yapi",     "pass": "yapi",     "authSource": ""   },   "mail": {     "enable": true,     "host": "smtp.gmail.com",     "port": 465,     "from": "*",     "auth": {       "user": "wangzhenjun1221@163.com",       "pass": "xxx"     }   } }

:wq退出

2、初始化数据库表

docker run -d --rm /  --name yapi-init /  --link mongodb:mongo /  --net=yapi /  -v /data/yapi/config.json:/yapi/config.json /   yapipro/yapi /  server/install.js

3、测试连接mongo

我们使用Navicat进行可视化的连接数据库输入：admin用户名密码都是刚刚配置的：yapi。

连接成功！！

4、运行yapi

docker run -d /   --name yapi /   --link mongodb:mongo /   --restart always /   --net=yapi /   -p 3000:3000 /   -v /data/yapi/config.json:/yapi/config.json /   yapipro/yapi /   server/app.js

5、测试使用

ip:3000http://192.168.84.144:3000/。

初始化管理员账号在上面的 config.json 配置中adminAccount初始化密码就是：yapi.pro。

6、新建项目

7、获取token

五、Idea中使用

1、下载插件

插件名称：EasyYapi。

2、配置插件

3、测试上传

找到controller。

选择你要上传的接口，点击对号上传！

填写token。

上传成功：

六、在线请求使用

1、配置地址

2、配置地址

3、安装cross-request 插件

发送请求时，会提醒你安装，你按照提示安装下载即可！

也可以下载小编的：

链接：https://pan.baidu.com/s/1Bx6nGFjKsQ3ajbnLPcjsSA 提取码：gljt。

直接解压，拖拽到这里就行！

4、点击发送

测试完成！！

七、总结

总的来说搭建还是比较简单，集成和使用也挺好用！非常推荐哈！

本文链接：http://www.28at.com/showinfo-26-5119-0.html只会使用Swagger？不妨试试YApi进行接口文档管理

声明：本网页内容旨在传播知识，若有侵权等问题请及时与本网联系，我们将在第一时间删除处理。邮件：2376512515@qq.com

上一篇： Go1.21 那些事：泛型库、for 语义变更、统一 log/slog、WASI 等新特性，你知道多少？

下一篇： SpringBoot3之Web编程

标签：

热门焦点

MIX Fold3包装盒泄露新机本月登场

小米的全新折叠屏旗舰MIX Fold3将于本月发布，近日该机的真机包装盒在网上泄露。从图上来看，新的MIX Fold3包装盒在外观设计方面延续了之前的方案，变化不大，这也是目前小米旗舰
小米平板5 Pro 12.4简评：多专多能兼顾影音娱乐的大屏利器

疫情带来了网课，网课盘活了安卓平板，安卓平板市场虽然中途停滞了几年，但好的一点就是停滞的这几年行业又有了新的发展方向，例如超窄边框、高刷新率、多摄镜头组合等，这就让安卓
三言两语说透设计模式的艺术-简单工厂模式

一、写在前面工厂模式是最常见的一种创建型设计模式，通常说的工厂模式指的是工厂方法模式，是使用频率最高的工厂模式。简单工厂模式又称为静态工厂方法模式，不属于GoF 23种设计
一个注解实现接口幂等，这样才优雅！

场景码猿慢病云管理系统中其实高并发的场景不是很多，没有必要每个接口都去考虑并发高的场景，比如添加住院患者的这个接口，具体的业务代码就不贴了，业务伪代码如下：图片上述代码有
零售大模型“干中学”，攀爬数字化珠峰

文/侯煜编辑/cc来源/华尔街科技眼对于绝大多数登山爱好者而言，攀爬珠穆朗玛峰可谓终极目标。攀登珠峰的商业路线有两条，一是尼泊尔境内的南坡路线，一是中国境内的北坡路线。相
消费结构调整丨巨头低价博弈，拼多多还卷得动吗？

来源：征探财经作者：陈香羽随着流量红利的退潮，电商的存量博弈越来越明显。曾经主攻中高端与品质的淘宝天猫、京东重拾“低价”口号。而过去与他们错位竞争的拼多多，靠
花7万退货退款无门：谁在纵容淘宝珠宝商家造假？

来源：极点商业作者：杨铭在淘宝购买珠宝玉石后，因为保证金不够赔付，店铺关闭，退货退款难、维权无门的比比皆是。“提供相关产品鉴定证书，支持全国复检，可以30天无理由退换货。&
OPPO K11搭载长寿版100W超级闪充：26分钟充满100%

据此前官方宣布，OPPO将于7月25日也就是今天下午14:30举办新品发布会，届时全新的OPPO K11将正式与大家见面，将主打旗舰影像，和同档位竞品相比，其最大的卖
亲历马斯克血洗Twitter，硅谷的苦日子在后头

文/刘哲铭　　编辑/李薇　　马斯克再次挥下裁员大刀。　　美国时间11月14日，Twitter约4400名外包员工遭解雇，此次被解雇的员工的主要工作为内容审核等。此前，T