接口文档管理神器YAPI

273 阅读2分钟

小知识,大挑战!本文正在参与“程序员必备小知识”创作活动。

前言

项目规范管理,基础能力建设,项目的过程资产等等,都离不开文档,对于开发而言, 一个微服务系统有哪些能力,对外提供哪些服务,都是有一系列接口构成。对于大公司而言可能有自己研发的一些接口文档管理协作的一些工具,然而对于小公司而言一切从0开始,项目文档规范可以从yapi规范开始去逐步完善。

参考文档

YAPI 旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API

官方文档: hellosean1025.github.io/yapi/index.…

YAPI 环境搭建

主要功能

主要分为6大块

  1. 权限管理
  2. 可视化接口管理
  3. Mock
  4. 自动化测试
  5. 数据导入
  6. 插件机制

image.png

对于我们来说非常好用的两个功能,可视化接口管理和Swagger 接口自动同步的功能, 这个给前后端分离开发的同学开发效率提升不止一点点。 下面我们就Yapi部署和Swagger同步这个功能写个demo来演示一下。

演示

部署

部署很简单, 官方文档写的很详细,参考部署就行

1.1 安装NodeJS

[root@VM_0_14_centos local]# cd /usr/local/
[root@VM_0_14_centos local]# wget https://npm.taobao.org/mirrors/node/v10.14.1/node-v10.14.1-linux-x64.tar.gz
[root@VM_0_14_centos local]# tar -xvf node-v10.14.1-linux-x64.tar.gz
[root@VM_0_14_centos local]# mv node-v10.14.1-linux-x64 node

配置环境变量

[root@VM_0_14_centos local]# vim /etc/profile

#set for nodejs  
export NODE_HOME=/usr/local/node  
export PATH=$NODE_HOME/bin:$PATH

最后查看

image.png

1.2 安装mongodb

Swagger 同步配置

接口可视化

FAQ

安装过程中遇到的一些问题也记录一下

  1. yum -y install wget 安装报错
[root@VM_0_14_centos ~]# yum -y install wget
error: rpmdb: BDB0113 Thread/process 9441/140522039842624 failed: BDB1507 Thread died in Berkeley DB library
error: db5 error(-30973) from dbenv->failchk: BDB0087 DB_RUNRECOVERY: Fatal error, run database recovery
error: cannot open Packages index using db5 -  (-30973)
error: cannot open Packages database in /var/lib/rpm
CRITICAL:yum.main:

Error: rpmdb open failed

解决方法, 执行下面重建命令,然后重新执行安装命令就好了。

[root@VM_0_14_centos ~]# cd /var/lib/rpm
[root@VM_0_14_centos rpm]# rm -rf __db*
[root@VM_0_14_centos rpm]# rpm --rebuilddb