當前位置：首頁 > 科技 > 軟件

只會使用Swagger？不妨試試YApi進行接口文檔管理

來源：責編：時間：2023-08-09 23:02:22 295觀看

導讀一、前言在我們后端開發中，必不可少的是接口的交接，有很多種方式，常見的就是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.tebozhan.com/showinfo-26-5119-0.html只會使用Swagger？不妨試試YApi進行接口文檔管理

聲明：本網頁內容旨在傳播知識，若有侵權等問題請及時與本網聯系，我們將在第一時間刪除處理。郵件：2376512515@qq.com

上一篇： Go1.21 那些事：泛型庫、for 語義變更、統一 log/slog、WASI 等新特性，你知道多少？

下一篇： SpringBoot3之Web編程

標簽：

熱門焦點

小米平板5 Pro 12.4簡評：多專多能兼顧影音娛樂的大屏利器

疫情帶來了網課，網課盤活了安卓平板，安卓平板市場雖然中途停滯了幾年，但好的一點就是停滯的這幾年行業又有了新的發展方向，例如超窄邊框、高刷新率、多攝鏡頭組合等，這就讓安卓
iPhone賣不動了！蘋果股價創年內最大日跌幅：市值一夜蒸發萬億元

8月5日消息，今天凌晨美股三大指數高開低走集體收跌，道指跌0.41%；納指跌0.36%；標普500指數跌0.52%。熱門科技股也都變化極大，其中蘋果報181.99美元，跌4.8%，創
太卷！Redmi MAX 100英寸電視便宜了：12999元買Redmi史上最大屏

8月5日消息，從小米商城了解到，Redmi MAX 100英寸巨屏電視日前迎來官方優惠，到手價12999元，比發布價便宜了7000元，在大屏電視市場開卷。據了解，Redmi MAX 100
Golang 中的 io 包詳解：組合接口

io.ReadWriter// ReadWriter is the interface that groups the basic Read and Write methods.type ReadWriter interface { Reader Writer}是對Reader和Writer接口的組合，
Flowable工作流引擎的科普與實踐

一.引言當我們在日常工作和業務中需要進行各種審批流程時，可能會面臨一系列技術和業務上的挑戰。手動處理這些審批流程可能會導致開發成本的增加以及業務復雜度的上升。在這
三言兩語說透柯里化和反柯里化

JavaScript中的柯里化(Currying)和反柯里化(Uncurrying)是兩種很有用的技術，可以幫助我們寫出更加優雅、泛用的函數。本文將首先介紹柯里化和反柯里化的概念、實現原理和應用
四年持續更迭堅持探索行業無人之境，HarmonyOS 4帶來五大升級多項創新

除了華為每年新發布的旗艦手機系列，上億花粉更加期待鴻蒙系統每次的跨版本大更新。8月4日，HarmonyOS 4于HDC 2023正式發布，這也是該系統歷經四年的再
華為Mate 60保護殼曝光：碩大后置相機模組凸起程度有驚喜

這段時間以來，關于華為新旗艦的爆料日漸密集。據此前多方爆料，今年華為將開始恢復一年雙旗艦戰略，除上半年推出的P60系列外，往年下半年的Mate系列也將
iQOO Neo8 Pro即將開售：到手價3099元起安卓性能最強旗艦

5月23日，iQOO如期舉行了新品發布會，全新的iQOO Neo8系列也正式與大家見面，包含iQOO Neo8和iQOO Neo8 Pro兩個版本，其中標準版搭載高通驍龍8+，而Pro版更