目錄
- Yapi介紹
- 優(yōu)點(diǎn):
- Yapi的幾個(gè)功能
- 1、啟動 MongoDB
- 2、獲取 Yapi 鏡像,版本信息可在 阿里云鏡像倉庫 查看
- 3、初始化 Yapi 數(shù)據(jù)庫索引及管理員賬號
- 4、啟動 Yapi 服務(wù)
- 5、Yapi 部署成功
Yapi介紹
Yapi是一個(gè)高效、易用、功能強(qiáng)大的接口文檔管理工具,旨在為開發(fā)、產(chǎn)品、測試人員提供更優(yōu)雅的接口管理服務(wù)。可以幫助開發(fā)者輕松創(chuàng)建、發(fā)布、維護(hù) API。
Yapi旨在為開發(fā)、產(chǎn)品、測試人員提供更優(yōu)雅的接口管理服務(wù)。可以幫助開發(fā)者輕松創(chuàng)建、發(fā)布、維護(hù) API。
優(yōu)點(diǎn):
1、提供基本的項(xiàng)目分組,項(xiàng)目管理,接口管理功能
2、友好的接口文檔,基于websocket的多人協(xié)作接口編輯功能和類postman測試工具,讓多人協(xié)作成倍提升開發(fā)效率
3、基于Mockjs,使用簡單功能強(qiáng)大
Yapi的幾個(gè)功能
權(quán)限管理:
YApi 成熟的團(tuán)隊(duì)管理扁平化項(xiàng)目權(quán)限配置滿足各類企業(yè)的需求。
可視化接口管理:
基于 websocket 的多人協(xié)作接口編輯功能和類 postman 測試工具,讓多人協(xié)作成倍提升開發(fā)效率。
Mock Server:
易用的 Mock Server,再也不用擔(dān)心 mock 數(shù)據(jù)的生成了
自動化測試:
完善的接口自動化測試,保證數(shù)據(jù)的正確性
數(shù)據(jù)導(dǎo)入:
支持導(dǎo)入 swagger, postman, har 數(shù)據(jù)格式,方便遷移舊項(xiàng)目
插件機(jī)制:
強(qiáng)大的插件機(jī)制,滿足各類業(yè)務(wù)需求
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 數(shù)據(jù)庫索引及管理員賬號
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 服務(wù)
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