我们为什么需要接口文档系统？

在我工作最初，和同事间沟通接口细节时，总是使用Word文档编写一份接口说明书。不仅编写麻烦，而且特别容易忘记更新，有些文档没有用svn等版本管理工具管理时，甚至会出现丢失的情况。

接口文档管理系统，专为解决此类问题而生。目前市面上挺多种类的，但其宗旨离不开帮助IT人员更便捷的定义、修改、查看、甚至调用接口。

Yapi是由去哪儿开源的一套接口管理系统，特别适合在内网搭建。GitHub地址：YAPI 。在这上面已经有很详细的介绍了，我这里主要讲讲我的踩坑经历。

Yapi搭建

Yapi的搭建提供了两种模式：1.可视化部署 2.命令行部署

1.可视化部署

首选，需要安装nodejs（7.6+) 与 mongodb（2.6+）。

这里建议node.js不要安装最新版本，我第一次部署使用V16.14.0，结果各种问题。后来改用V12.22.10版本，一路顺畅~

执行 yapi server 启动可视化部署程序，输入相应的配置和点击开始部署，就能完成整个网站的部署。部署完成之后，可按照提示信息，执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱，默认密码(ymfe.org) 登录系统（默认密码可在个人中心修改）。

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

2.命令行部署

mkdir yapi
cd yapi
git clone https://github.com/YMFE/yapi.git vendors //或者下载 zip 包解压到 vendors 目录（clone 整个仓库大概 140+ M，可以通过 `git clone --depth=1 https://github.com/YMFE/yapi.git vendors` 命令减少，大概 10+ M）
cp vendors/config_example.json ./config.json //复制完成后请修改相关配置
cd vendors
npm install --production --registry https://registry.npm.taobao.org
npm run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
node server/app.js //启动服务器后，请访问 127.0.0.1:{config.json配置的端口}，初次运行会有个编译的过程，请耐心等候

3.启动

官方文档中推荐的node app.js启动方式，会在会话关闭后停止服务。

推荐安装forever，来管理服务并保持。

全局安装forever：sudo npm install forever -g

启动服务：forever start app.js

查看当前forever启动服务目录：forever list

停止pid下的服务：forever stop [pid]

停止所有服务：forever stopall

Yapi使用

Yapi使用教程：https://hellosean1025.github.io/yapi/documents/index.html

使用还是相对简单的，和postman类似，在安装插件后，还支持在线发送请求，以及自定义Mock。

接口文档系统 - Yapi相关推荐

unity3d api 中文文档_接口文档系统-showdoc安装部署
ShowDoc简介 ShowDoc是一个开源.免费的工具 ShowDoc是一个非常适合IT团队的在线API文档,技术文档工具,它可实现实时同步,用户无需花费过多的精力维护文档. 借助ShowDoc可以 ...
yapi接口导出为word_接口文档神器YApi
什么是YApi 官网上是这么介绍的:YApi 是一个可本地部署的.打通前后端及QA的.可视化的接口管理平台 https://hellosean1025.github.... 可以这么说YApi兼具sw ...
yapi 接口文档_接口文档神器YApi
什么是YApi 官网上是这么介绍的:YApi 是一个可本地部署的.打通前后端及QA的.可视化的接口管理平台 https://hellosean1025.github.... 可以这么说YApi兼具sw ...
商品库存推送至外部系统API接口文档
没有与外部系统对接,商品库存数据不通?往下看看电商API文档---点击查看!http://ds.xnxxxk.cn/apijk?comefrom=CSDN&plan=kucuntongbu1 ...
Zabbix系统接口文档
Zabbix系统接口文档 (V1.0) 2018.3 注:已上传word版,如需下载请前往https://download.cs ...
驰骋工作流引擎与第三方系统的接口文档For 山东金义
驰骋工作流引擎与第三方系统的接口文档For 山东金义驰骋BPM要与第3方系统的接口主要有发起.待办.在途.查询4个菜单,如果被集成的系统由于风格问题需要自己生成发起,待办,在途三个页面,最有效的办法 ...
接口文档管理工具--Yapi安装
前言现在咱们做的项目都是前后端分离的,这样就可以保证前端和后端可以同时进行,但是同时会出现一个问题->前端不知道咱们服务器的接口是怎么定义的,不知道里面的参数应该如何传递.这个时候就需要使用接 ...
idea中使用yapi插件自动生成yapi接口文档
1.在idea的plugin中搜索easy-yapi插件 2.安装后重启idea 3.打开setting,在Other Settings下出现EasyApi菜单项,点开出现如下界面 4.填充Yapi地 ...
基于 apidoc 生成在线接口文档（实时更新）（linux系统）
基于 apidoc 生成在线接口文档 (实时更新)(linux系统) 动态加载,热部署背景: 规范开发人员的接口文档文档统一管理,防止本地文档版本不统一远程部署,保证文档的统一性主要还是解决, ...
三网话费、充值系统搭建、电费充值API接口文档
一.文档综述近期想做项目的看过来~三网(全国移动.联通.电信)话费.电费充值接口能够实现将接口接入到公众号或者app上面,通过接口提交号码和金额进行充值,可以帮助相关人员快速完成接口对接与联调,平台 ...

接口文档系统 - Yapi

导航