部署YApi可视化接口管理平台

修改时间: 2019-12-5 22:07:32 PM

文章时间:2019年12月5日 20:26:19
解决问题:部署YApi可视化接口管理平台
基于环境:Linux Cent os + 宝塔
ps:宝塔已安装Nginx

第一步 安装Mongdb&PM2管理器

v001.png

在宝塔面板内,点击软件商店,安装Mongdb和PM2管理器。

第二步 宝塔内创建一个站点

v001.5.png

创建好站点之后,不要忘记域名的解析操作。

第三步 安装YApi

YApi官网:https://yapi.ymfe.org/

直接运行下面的命令即可。

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

这个时候提示,在浏览器中打开 http://0.0.0.0:9090访问。……ip换成自己服务器的

开放端口

  • 1、宝塔 安全 放行端口,放行9090端口。
  • 2、阿里云 安全组 放行端口,放行9090端口。

创建数据库

v002.png

创建一个MongDB数据库。

可视化安装

v003.png

安装完成之后,均会有提示,输入对应的ip加端口即可访问。

v004.png
v005.png

这里我们还需要修改域名访问和配置邮箱,所以继续往下看。

第四步 配置域名访问

我们的宝塔环境已经安装过了Nginx,所以直接修改配置文件。可以按照我下面的进行修改。(里面会有websocket的坑)

server
{
    listen 80;
    server_name api.hcses.com;
    location / {
        proxy_pass http://localhost:3000;
        index  index.html;
        proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    }

    #SSL-START SSL相关配置,请勿删除或修改下一行带注释的404规则
    #error_page 404/404.html;
    #SSL-END

    #ERROR-PAGE-START  错误页配置,可以注释、删除或修改
    #error_page 404 /404.html;
    #error_page 502 /502.html;
    #ERROR-PAGE-END

    #PHP-INFO-START  PHP引用配置,可以注释或修改
    include enable-php-00.conf;
    #PHP-INFO-END

    #REWRITE-START URL重写规则引用,修改后将导致面板设置的伪静态规则失效
    include /www/server/panel/vhost/rewrite/api.hcses.com.conf;
    #REWRITE-END

    #禁止访问的文件或目录
    location ~ ^/(\.user.ini|\.htaccess|\.git|\.svn|\.project|LICENSE|README.md)
    {
        return 404;
    }

    #一键申请SSL证书验证目录相关设置
    location ~ \.well-known{
        allow all;
    }

    access_log  /www/wwwlogs/api.hcses.com.log;
    error_log  /www/wwwlogs/api.hcses.com.error.log;
}

第五步 添加PM2管理

打开PM2管理器,添加一个启动。

项目根目录:vendors/server/
启动文件名称:app.js
项目名称:自己起个

v008.png

添加好之后,点击启动即可。

第六步 扩展配置及插件

配置邮箱

v006.png

修改跟目录下的config.json文件里面的参数

修改完一定记得要重启一下哈!

v007.png

全部完成运行效果如上!

安装插件

官网插件地址:https://yapi.ymfe.org/documents/plugin-list.html

我们以安装 export-docx-data 数据导出docx文档 为例安装方法如下:

cd {项目目录}
yapi-cli plugin --name yapi-plugin-export-docx-data

v009.png

安装完成之后,PM2重启一下即可。

添加新评论