目錄
- Yapi介紹
- 優點:
- Yapi的幾個功能
- 1、啟動 MongoDB
- 2、獲取 Yapi 鏡像,版本信息可在 阿里云鏡像倉庫 查看
- 3、初始化 Yapi 數據庫索引及管理員賬號
- 4、啟動 Yapi 服務
- 5、Yapi 部署成功
Yapi介紹
Yapi是一個高效、易用、功能強大的接口文檔管理工具,旨在為開發、產品、測試人員提供更優雅的接口管理服務。可以幫助開發者輕松創建、發布、維護 API。
Yapi旨在為開發、產品、測試人員提供更優雅的接口管理服務。可以幫助開發者輕松創建、發布、維護 API。
優點:
1、提供基本的項目分組,項目管理,接口管理功能
2、友好的接口文檔,基于websocket的多人協作接口編輯功能和類postman測試工具,讓多人協作成倍提升開發效率
3、基于Mockjs,使用簡單功能強大
Yapi的幾個功能
權限管理:
YApi 成熟的團隊管理扁平化項目權限配置滿足各類企業的需求。
可視化接口管理:
基于 websocket 的多人協作接口編輯功能和類 postman 測試工具,讓多人協作成倍提升開發效率。
Mock Server:
易用的 Mock Server,再也不用擔心 mock 數據的生成了
自動化測試:
完善的接口自動化測試,保證數據的正確性
數據導入:
支持導入 swagger, postman, har 數據格式,方便遷移舊項目
插件機制:
強大的插件機制,滿足各類業務需求
1、啟動 MongoDB
前提需要安裝docker:安裝docker:
https://www.jb51.net/article/257872.htm
由于YApi依賴于MongoDB,所以我們需要下載并啟動MongoDB。
docker run -d --name mongo-yapi mongo
2、獲取 Yapi 鏡像,版本信息可在 阿里云鏡像倉庫 查看
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi
3、初始化 Yapi 數據庫索引及管理員賬號
docker run -it --rm \ --link mongo-yapi:mongo \ --entrypoint npm \ --workdir /api/vendors \ registry.cn-hangzhou.aliyuncs.com/anoy/yapi \ run install-server
4、啟動 Yapi 服務
docker run -d \ --name yapi \ --link mongo-yapi:mongo \ --workdir /api/vendors \ -p 3000:3000 \ registry.cn-hangzhou.aliyuncs.com/anoy/yapi \ server/app.js
5、Yapi 部署成功
訪問 http://localhost:3000 登錄賬號 [email protected],密碼 ymfe.org
http://localhost:3000