介紹
YApi 是高效、易用、功能強大的 api 管理平臺,旨在為開發、產品、測試人員提供更優雅的介面管理服務。可以幫助開發者輕鬆建立、釋出、維護 API,YApi 還為使用者提供了優秀的互動體驗,開發人員只需利用平臺提供的介面資料寫入工具以及簡單的點選操作就可以實現介面的管理。
當下稍微正式一點的公司都會要求前後端聯調要求編寫介面文件,比如說要求word或者excel等了,這個時候你要說那麼我們可以使用swagger,但是領導又會說swagger不能留檔,並且顯得不太正式,結果就強制要求使用word,奈何太浪費時間,通過yapi,它可以直接匯出檔案進行存檔,並且介面內容也可以通過swagger定時同步。
GitHub:https://github.com/YMFE/yapi
Docker部署:https://github.com/fjc0k/docker-YApi
安裝Yapi
自己搭建mongo
前提是需要安裝mongdb用於儲存資料,當前我已經安裝了MongoDB,配置如下
docker run -p 27017:27017 --name mongo -e TZ=Asia/Shanghai -d mongo
服務地址:192.168.1.12
埠:27017
資料庫:yapi
因為設定帶密碼的mongodb一直沒成功,所以採用了無密碼的
通過docker生成yapi服務
docker run -p 8009:3000 --name yapiweb -e YAPI_ADMIN_ACCOUNT=itzhangyunpeng@163.com -e YAPI_ADMIN_PASSWORD=123456 -e YAPI_CLOSE_REGISTER=true -e YAPI_DB_SERVERNAME=192.168.1.6 -e YAPI_DB_PORT=27017 -e YAPI_DB_DATABASE=yapi -e YAPI_MAIL_ENABLE=false -e YAPI_LDAP_LOGIN_ENABLE=false -d jayfong/yapi:latest
使用了大佬提供的映象:jayfong/yapi
詳細配置還得看GitHub文件介紹,注意資料庫的地址資訊
開箱即用版本
# 純粹的
docker run --rm -p 8009:3000 -d jayfong/yapi:play
# 帶外掛的
docker run --rm -p 8009:3000 -e YAPI_PLUGINS='[{"name":"interface-oauth2-token"}]' -d jayfong/yapi:play
預設的管理員賬號:
admin@docker.yapi
,管理員密碼:adm1n
。
基本使用Yapi
登入
通過瀏覽器訪問地址:http://localhost:8009/
帳號密碼就是上面配置的管理員密碼:YAPI_ADMIN_ACCOUNT=itzhangyunpeng@163.com YAPI_ADMIN_PASSWORD=123456
使用者管理
檢視使用者
新增使用者
個人專案
建立
展示個人專案
該個人專案只能自己才看看到
分組
建立分組
一個專案組一般為一個分組,然後其他的人都在該分組中編輯本分組的專案
分組成員
管理本分組人員操作和簡單操作許可權。
分組動態
展示分組內每個使用者的操作記錄
新增介面
修改介面
搭配swagger
關於swagger基礎配置可以檢視:此處
建立專案
使用前文的.net程式,並顯示swagger資訊,swagger地址為:http://azrng.cn1.utools.club/swagger/index.html
獲取swagger的json地址
Yapi配置
本次使用的是完全覆蓋,通過cron表示式配置自動同步時間。
檢視同步資料
然後我們檢視介面列表,這個時候我們已經看到專案的介面已經都被同步過來了
資料管理
資料匯出匯入
在資料管理我們可以匯入資料,或者匯出資料
對於我來說我常用的就是資料匯出為html給留檔使用。
匯出預覽
更多配置還需要檢視官方文件