Interface documentation system - Yapi

Why do we need an interface documentation system ？

   At the beginning of my work , When communicating interface details with colleagues , Always used Word Document an interface specification . Not only writing is troublesome , And it's especially easy to forget to update , Some documents are useless svn And so on , Even lost .

   Interface document management system , Designed to solve such problems . There are many kinds on the market at present , But its purpose is inseparable from help IT More convenient definition of people 、 modify 、 see 、 Even call the interface .

  Yapi It is an interface management system opened by qunar , It is especially suitable for building in the intranet .GitHub Address ：YAPI . It has been introduced in detail , Here I mainly talk about my experience of stepping on pits .

Yapi build

  Yapi There are two modes to build ：1. Visual deployment 2. Command line deployment

1. Visual deployment

   The preferred , Need to install nodejs（7.6+) And mongodb（2.6+）.

   Here's the advice node.js Do not install the latest version , I deployed for the first time V16.14.0, As a result, all kinds of problems . Later, I changed to V12.22.10 edition , All the way ~

   perform yapi server Start the visual deployer , Enter the appropriate configuration and click Start deployment , Can complete the whole website deployment . After deployment , Follow the prompts , perform node/{ Website path /server/app.js} Start the server . Open the specified... In the browser url, Click login to enter the administrator email you just set , Default password (ymfe.org) Login system （ The default password can be changed in the personal center ）.

	npm install -g yapi-cli --registry https://registry.npm.taobao.org
	yapi server

2. Command line deployment

mkdir yapi
cd yapi
git clone https://github.com/YMFE/yapi.git vendors // Or download  zip  Unpack the package to  vendors  Catalog （clone  The whole warehouse is about  140+ M, Can pass  `git clone --depth=1 https://github.com/YMFE/yapi.git vendors`  Command reduction , Probably  10+ M）
cp vendors/config_example.json ./config.json // Please modify the configuration after copying 
cd vendors
npm install --production --registry https://registry.npm.taobao.org
npm run install-server // Setup will initialize database index and administrator account , The administrator account name can be found in  config.json  To configure 
node server/app.js // After starting the server , Please visit  127.0.0.1:{
    config.json Configured port }, The first run will have a compilation process , Please wait patiently 

3. start-up

   Recommended in official documents node app.js Starting mode , The service will be stopped after the session is closed .

   Recommended installation forever, To manage services and maintain .

   Global installation forever：sudo npm install forever -g

   Start the service ：forever start app.js

   View the current forever Start service directory ：forever list

   stop it pid Next service ：forever stop [pid]

   Stop all services ：forever stopall

Yapi Use

  Yapi Use the tutorial ：https://hellosean1025.github.io/yapi/documents/index.html

   It is relatively simple to use , and postman similar , After installing the plug-in , It also supports sending requests online , And customization Mock.