【如何部署yapi文档】

概要

  YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理

部署流程

1、部署mongoDB数据库
2、安装nodeJs环境
3、安装yapi程序，进入图形化部署界面部署yapi

技术细节

一、部署mongoDB数据库

1、点击【Download】下载到本地后再上传至服务器或者点击【Copy Link】直接wget进行下载

wget https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-rhel70-4.4.6.tgz

2、解压

`tar -xzf mongodb-linux-x86_64-rhel70-4.4.6.tgz -C /usr/local/
cd /usr/local/
mv mongodb-linux-x86_64-rhel70-4.4.6/ mongodb4.4.6`

3、添加环境变量

vim /etc/profile
export PATH=/usr/local/mongodb4.4.6/bin:$PATH

source /etc/profile  # 使环境变量生效

4、创建目录，并生成日志文件

mkdir -p /data/mongodb/{data,logs}
touch /data/mongodb/logs/mongodb.log

# data：数据目录
# logs：日志目录

5、修改配置文件

cd /usr/local/mongodb4.4.6
vim mongodb.conf
--------------------------------------
port=8090
bind_ip=0.0.0.0
dbpath=/data/mongodb/data
logpath=/data/mongodb/logs/mongodb.log
logappend=true
fork=true

# port：自定义端口
# bind_ip：允许远程IP连接
# dbpath：数据路径
# logpath：日志路径
# logappend：可追加日志
# fork：后台运行

6、配置systemctl管理

cd /usr/lib/systemd/system/
cat >>mongodb.service<<"EOF"
[Unit]
Description=mongodb
After=network.target remote-fs.target nss-lookup.target

[Service]
Type=forking
ExecStart=/usr/local/mongodb4.4.6/bin/mongod --config /usr/local/mongodb4.4.6/mongodb.conf
ExecReload=/bin/kill -s HUP $MAINPID
ExecStop=/usr/local/mongodb4.4.6/bin/mongod --shutdown --config /usr/local/mongodb4.4.6/mongodb.conf
PrivateTmp=true

[Install]
WantedBy=multi-user.target
EOF

7、启动

systemctl start mongodb.service
systemctl enable mongodb.service

8、登录验证

mongo  IP地址[:端口]
mongo 10.20.10.61:8090
注意：如果是云服务器上面部署mongoDB,需要开放对应端口，并重启防火墙

9、创建用户并授予读写权限

use <DATABASE_NAME>   # 不存在则创建
db                    # 查看当前所在数据库
show dbs              # 查看所有数据库

use admin    # 管理员需要在admin数据库下创建，所以我们需要切换到admin数据库。
db.system.users.find()   # 查看admin中的用户

# 在MongoDB中可以使用db.createUser({用户信息})函数创建用户：
db.createUser({
    user: "<name>",
    pwd: "<cleartext password>",
    customData: { <any information> },
    roles: [
        { role: "<role>", db: "<database>" } | "<role>",
        ...
    ]
});
# 说明：
1）user:新建用户名。
2）pwd:新建用户密码。
3）customData:存放一些用户相关的自定义数据，该属性也可忽略。
4）roles:数组类型，配置用户的权限。

二、YAPI部署
YAPI部署有两种方式，包括图形化界面部署和命令行部署
方式一：可视化部署
1、下载按照nodeJs环境

tar xf node-v14.17.3-linux-x64.tar.xz -C /usr/local/
cd /usr/local/
mv node-v14.15.4-linux-x64 nodejs
vim /etc/profile
-------------------------------------------------------
export NODE_HOME=/usr/local/nodejs
export PATH=$PATH:$NODE_HOME/bin
-------------------------------------------------------
source /etc/profile

# 作用于YAPI源码（yapi需要NodeJs环境，进行编译部署）

2、按照yapi

npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server    # 前台执行，点击下图【开始部署】时会在终端打出相关日志

浏览器访问 http://ip:9090/ 进行可视化部署(同样，如果是云服务器yapi 9090端口需要开放给远程服务器)

方式二、源码安装（略）
三、验证
登录 ip:3000访问yapi登录页面

四、在yapi中添加项目
1、登录yapi之后页面会有yapi文档的token,该token用于将idea项目接口加入到yapi管理

2、idea下载easyApi插件，并且绑定yapi服务器地址和token

3、新建接口之后，点击右键easyApi–》export Yapi即可将接口同步到yapi文档

小结

1、什么是yapi?

接口管理平台，为开发，测试，产品提供更加优雅的接口管理服务。

2、yapi特点

高效性、易用性、免费开源。

3、注意点

nodejs环境；

两种安装方式，可视化安装和源码编译安装；

可视化安装容易出错，不灵活，建议源码安装；

git clone 源码时由于仓库数据较大，可添加–depth=1，来克隆下包含最近一次commit的一个分支。

4、什么是mongoDB？

MongoDB 是一个基于分布式文件存储的数据库。由 C++ 语言编写。旨在为 WEB 应用提供可扩展的高性能数据存储解决方案。

MongoDB 是一个介于关系数据库和非关系数据库之间的产品，是非关系数据库当中功能最丰富，最像关系数据库的

5、MongoDB特点

面向文档存储;

安装简单 ；

扩展性强；

支持各种编程语言:RUBY，PYTHON，JAVA，C++，PHP，C#等多种语言；

支持丰富的查询表达式。查询指令使用JSON形式的标记，可轻易查询文档中内嵌的对象及数组。

6、其他注意点

端口：如果是云服务器部署，记得开放端口；
防火墙：关闭firewalld；
selinux：关闭SELINUX。