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

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

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

导读一、前言在我们后端开发中，必不可少的是接口的交接，有很多种方式，常见的就是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编程

标签：

热门焦点

Mate60手机壳曝光致敬自己的经典设计

8月3日消息，今天下午博主数码闲聊站带来了华为Mate60的第三方手机壳图，可以让我们在真机发布之前看看这款华为全新旗舰的大致轮廓。从曝光的图片看，Mate 60背后摄像头面积依然
7月安卓手机性能榜：红魔8S Pro再夺榜首

7月份的手机市场风平浪静，除了红魔和努比亚带来了两款搭载骁龙8Gen2领先版处理器的新机之外，别的也想不到有什么新品了，这也正常，通常6月7月都是手机厂商修整的时间，进入8月份之
自动化在DevOps中的力量：简化软件开发和交付

自动化在DevOps中扮演着重要角色，它提升了DevOps的效能。通过自动化工具和方法，DevOps团队可以实现以下目标：消除手动和重复性任务。简化流程。在整个软件开发生命周期中实现更
10天营收超1亿美元，《星铁》比《原神》差在哪？

来源：伯虎财经作者：陈平安即便你没玩过《原神》，你一定听说过的它的大名。恨它的人把《原神》开服那天称作是中国游戏史上最黑暗的一天，有粉丝因为索尼在PS平台上线《原神》，怒而
花7万退货退款无门：谁在纵容淘宝珠宝商家造假？

来源：极点商业作者：杨铭在淘宝购买珠宝玉石后，因为保证金不够赔付，店铺关闭，退货退款难、维权无门的比比皆是。“提供相关产品鉴定证书，支持全国复检，可以30天无理由退换货。&
OPPO、vivo、小米等国内厂商Q2在印度智能手机市场份额依旧高达55%

7月20日消息，据外媒报道，研究机构的报告显示，在全球智能手机出货量同比仍在下滑的大背景下，印度这一有潜力的市场也未能幸免，出货量同比也有下滑，多家厂
华为Mate 60保护壳曝光：硕大后置相机模组凸起程度有惊喜

这段时间以来，关于华为新旗舰的爆料日渐密集。据此前多方爆料，今年华为将开始恢复一年双旗舰战略，除上半年推出的P60系列外，往年下半年的Mate系列也将
2022爆款：ROG魔霸6 冰川散热系统持续护航

喜逢开学季，各大商家开始推出自己的新产品，进行打折促销活动。对于忠实的端游爱好者来说，能够拥有一款梦寐以求的笔记本电脑是一件十分开心的事。但是现在的
华为举行春季智慧办公新品发布会首次推出电子墨水屏平板

北京时间2月27日晚，华为在巴塞罗那举行春季智慧办公新品发布会，在海外市场推出之前已经在中国市场上市的笔记本、平板、激光打印机等办公产品，并首次推出搭载