1. Introduction
YApi It is an open source project launched by the Qunar Mobile Architecture Group. It is an efficient, easy-to-use, and powerful api management platform designed to provide developers, products, and testers with more elegant interface management services.
Official website: https://yapi.ymfe.org/
github: https://hellosean1025.github .io/yapi/
Document: https://hellosean1025.github.io/yapi/documents/index.html
Features:
- Permission Management
- The flat permission design not only ensures the management of large-scale enterprise-level projects, but also ensures the ease of use
- Mock server
- websocket-based multi-person collaboration interface editing function and postman-like test Tools to double the development efficiency of multi-person collaboration
- Data import
- The interface supports importing swagger, postman, har data format, which is convenient for migrating old projects
- Visualization interface
- websocket-based multi-person collaboration interface editing function and postman-like testing tool, allowing multi-person collaboration Doubly improve development efficiency
- Automated testing
- Perfect interface automated testing to ensure the correctness of data and support assertion on Response
- Plugin mechanism
- Powerful
2, install
https ://hellosean1025.github.io/yapi/devops/index.html#%E5%AE%89%E8%A3%85
Environmental requirements
- nodejs(7.6+)
- mongodb(2.6+)
windows
Environment
1, install node.js
https://www.runoob.com/nodejs/nodejs-install-setup.html
2, install MongoDB
https://www.runoob.com/mongodb/ mongodb-window-install.html
3, install git
https://www.runoob.com/git/git-install-setup.html
4, executenpm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
Enter the visual installation page
http://127.0.0.1:9000Edit the company name and email address, click to start deployment
Execute node vendors/server/app.js
Prompt that the installation is complete
Visit http://127.0.0.1:3000
User login: Enter what you just Set the administrator mailbox, the default password (ymfe.org) to log in to the system (the default password can be modified in the personal center).
Server management
PM2 is a node process management tool, you can use it to simplify many tedious tasks of node application management, such as performance monitoring, automatic restart, load Balance and so on, and it's very easy to use.
The official website recommends using pm2 to manage the start and stop of the node server. For specific usage, please refer to the following tutorial: p>
- pm2 official document: http://pm2.keymetrics.io/docs/usage/quick-start/#list-managed-applications< /span>
- PM2 Getting Started Guide: https://imweb.io/topic/57c8cbb27f226f687b365636
Install
npm install [emailprotected] -g
Execute
Switch to the vendors directory of yapi and execute pm2 start
pm2 start server/app.js --watch
Linux installation
Docker installation: https://www.cnblogs.com/qgc1995/p /9549896.html
1, install node.js
https://www.runoob .com/nodejs/nodejs-install-setup.html
2, install MongoDB
https://www.runoob.com/mongodb/mongodb-window-install.html
3, install git
https://www.runoob.com/git/git-install-setup.html
4, execute
npm < span class="token function" style="box-sizing: border-box; -webkit-tap-highlight-color: rgba(0, 0, 0, 0); margin: 0px; padding: 0px; color: #dd4a68 ;">install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
Enter the visual installation page
http://127.0.0.1:9000
Edit the company name and email address, click to start deployment
Execute node vendors/server/app.js
Prompt the installation is complete
Visit http://127.0.0.1: 3000
User login: Enter the administrator mailbox you just set, the default password (ymfe.org) to log in to the system (the default password can be Modify in the personal center).
npm install [emailprotected] -g
pm2 start server/app.js --watch