當(dāng)前位置：首頁 > 科技 > 軟件

只會使用Swagger？不妨試試YApi進(jìn)行接口文檔管理

來源：責(zé)編：時間：2023-08-09 23:02:22 330觀看

導(dǎo)讀一、前言在我們后端開發(fā)中，必不可少的是接口的交接，有很多種方式，常見的就是swagger，不過這個侵入性太強(qiáng)了。還有就是接口文檔的框架，比如今天小編帶大家一起搭建的yapi，在公司還是挺常見的！今天小編就大家從搭建到使用，詳細(xì)

一、前言

在我們后端開發(fā)中，必不可少的是接口的交接，有很多種方式，常見的就是swagger，不過這個侵入性太強(qiáng)了。還有就是接口文檔的框架，比如今天小編帶大家一起搭建的yapi，在公司還是挺常見的！今天小編就大家從搭建到使用，詳細(xì)的教學(xué)一波哈！

二、介紹

1、平臺介紹

YApi 是高效、易用、功能強(qiáng)大的 api 管理平臺，旨在為開發(fā)、產(chǎn)品、測試人員提供更優(yōu)雅的接口管理服務(wù)。可以幫助開發(fā)者輕松創(chuàng)建、發(fā)布、維護(hù) API，YApi 還為用戶提供了優(yōu)秀的交互體驗，開發(fā)人員只需利用平臺提供的接口數(shù)據(jù)寫入工具以及簡單的點擊操作就可以實現(xiàn)接口的管理。

2、特性

基于 Json5 和 Mockjs 定義接口返回數(shù)據(jù)的結(jié)構(gòu)和文檔，效率提升多倍。
扁平化權(quán)限設(shè)計，即保證了大型企業(yè)級項目的管理，又保證了易用性。
類似 postman 的接口調(diào)試。
自動化測試, 支持對 Response 斷言。
MockServer 除支持普通的隨機(jī) mock 外，還增加了 Mock 期望功能，根據(jù)設(shè)置的請求過濾規(guī)則，返回- - 期望數(shù)據(jù)。
支持 postman, har, swagger 數(shù)據(jù)導(dǎo)入。
免費開源，內(nèi)網(wǎng)部署，信息再也不怕泄露了。

3、環(huán)境支持

nodejs（7.6+)
mongodb（2.6+）
git

在docker中只需要搭建一下mongo，用來數(shù)據(jù)的存儲即可！

三、運行mongo

1、創(chuàng)建網(wǎng)絡(luò)

docker network create yapi

2、創(chuàng)建掛載文件

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、進(jìn)入容器初始化數(shù)據(jù)庫

進(jìn)入 MongoDB 容器，從上圖查看 MongoDB 容器可以獲取到容器 id，以下示例使用 50f1f6c50139代表 MongoDB 的容器 id，只需要簡寫即可！

docker exec -it 50 /bin/bash

接著輸入：

mongosh

「新版本需要加上sh，不然無法進(jìn)入！」

use admin;db.auth("yapi", "yapi");# 創(chuàng)建 yapi 數(shù)據(jù)庫use yapi;# 創(chuàng)建給 yapi 使用的賬號和密碼，限制權(quán)限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、初始化數(shù)據(jù)庫表

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進(jìn)行可視化的連接數(shù)據(jù)庫輸入：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 插件

發(fā)送請求時，會提醒你安裝，你按照提示安裝下載即可！

也可以下載小編的：

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

直接解壓，拖拽到這里就行！

4、點擊發(fā)送

測試完成！！

七、總結(jié)

總的來說搭建還是比較簡單，集成和使用也挺好用！非常推薦哈！

本文鏈接：http://www.www897cc.com/showinfo-26-5119-0.html只會使用Swagger？不妨試試YApi進(jìn)行接口文檔管理

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

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

下一篇： SpringBoot3之Web編程

標(biāo)簽：

熱門焦點

2023 年的 Node.js 生態(tài)系統(tǒng)

隨著技術(shù)的不斷演進(jìn)和創(chuàng)新，Node.js 在 2023 年達(dá)到了一個新的高度。Node.js 擁有一個龐大的生態(tài)系統(tǒng)，可以幫助開發(fā)人員更快地實現(xiàn)復(fù)雜的應(yīng)用。本文就來看看 Node.js 最新的生
之家push系統(tǒng)迭代之路

前言在這個信息爆炸的互聯(lián)網(wǎng)時代，能夠及時準(zhǔn)確獲取信息是當(dāng)今社會要解決的關(guān)鍵問題之一。隨著之家用戶體量和內(nèi)容規(guī)模的不斷增大，傳統(tǒng)的靠"主動拉"獲取信息的方式已不能滿足用
造車兩年股價跌六成，小米的估值邏輯變了嗎？

如果從小米官宣造車后的首個交易日起持有小米集團(tuán)的股票，那么截至2023年上半年最后一個交易日，投資者將浮虧59.16%，同區(qū)間的恒生科技指數(shù)跌幅為52.78%
OPPO、vivo、小米等國內(nèi)廠商Q2在印度智能手機(jī)市場份額依舊高達(dá)55%

7月20日消息，據(jù)外媒報道，研究機(jī)構(gòu)的報告顯示，在全球智能手機(jī)出貨量同比仍在下滑的大背景下，印度這一有潛力的市場也未能幸免，出貨量同比也有下滑，多家廠
華為Mate60系列模具曝光：采用碩大圓形后置相機(jī)模組+拼接配色方案

據(jù)此前多方爆料，今年華為將開始恢復(fù)一年雙旗艦戰(zhàn)略，除上半年推出的P60系列外，往年下半年的Mate系列也將迎來更新，有望在9-10月份帶來全新的華為Mate60
三星Galaxy Z Fold5今日亮相：厚度縮減但仍略顯厚重

據(jù)官方此前宣布，三星將于7月26日也就是今天在韓國首爾舉辦Unpacked活動，屆時將帶來帶來包括Galaxy Buds 3、Galaxy Watch 6、Galaxy Tab S9、Galaxy
OPPO K11樣張首曝：千元機(jī)影像“卷”得真不錯！

一直以來，OPPO K系列機(jī)型都保持著較為均衡的產(chǎn)品體驗，歷來都是2K價位的明星機(jī)型，去年推出的OPPO K10和OPPO K10 Pro兩款機(jī)型憑借各自的出色配置，堪稱有
OPPO Reno10 Pro英雄聯(lián)盟定制禮盒公布：薩勒芬妮同款配色夢幻十足

5月24日，OPPO推出了全新的OPPO Reno 10系列，包含OPPO Reno10、OPPO Reno10 Pro和OPPO Reno10 Pro+三款新機(jī)，全系標(biāo)配了超光影長焦鏡頭，是迄今為止拍照
最薄的14英寸游戲筆記本電腦 Alienware X14已可以購買

2022年1月份在國際消費電子展(CES2022)上首次亮相的Alienware新品——Alienware X14現(xiàn)在已經(jīng)可以購買了，這款筆記本電腦被譽(yù)為世界上最薄的 14 英寸游戲筆