介紹

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/

image.png

帳號密碼就是上面配置的管理員密碼：YAPI_ADMIN_ACCOUNT=itzhangyunpeng@163.com ?YAPI_ADMIN_PASSWORD=123456

用戶管理

查看用戶

image.png

添加用戶

image.png

個人項目

創建

image.png

展示個人項目

image.png

該個人項目只能自己才看看到

分組

創建分組

image.png

一個項目組一般為一個分組，然后其他的人都在該分組中編輯本分組的項目

分組成員

image.png

管理本分組人員操作和簡單操作權限。

分組動態

image.png

展示分組內每個用戶的操作記錄

添加接口

image.png

修改接口

image.png

搭配swagger

關于swagger基礎配置可以查看：此處

創建項目

使用前文的.net程序，并顯示swagger信息，swagger地址為：http://azrng.cn1.utools.club/swagger/index.html

image.png

獲取swagger的json地址

image.png

Yapi配置

image.png

本次使用的是完全覆蓋，通過cron表達式配置自動同步時間。

查看同步數據

然后我們查看接口列表，這個時候我們已經看到項目的接口已經都被同步過來了

image.png

數據管理

數據導出導入

在數據管理我們可以導入數據，或者導出數據

image.png

對于我來說我常用的就是數據導出為html給留檔使用。

導出預覽

image.png

更多配置還需要查看官方文檔

總結

以上是生活随笔為你收集整理的接口管理平台YApi的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。