YAPI 部署从零到一,我都帮你梳理好了

目录

  • 原创声明
  • 前言
  • 一、什么是 YAPI
  • 二、开始部署
    • 2.1 node.js
    • 2.2 mongodb
    • 2.3 YAPI
  • 总结
  • 参考
  • 授权须知

原创声明

本文为 HinGwenWoong 原创,如果这篇文章对您有帮助,欢迎转载,转载请阅读文末的【授权须知】,感谢您对 HinGwenWoong 文章的认可!


前言

我们平常开发的时候,服务总需要入参的返回,我们在接口一多的情况下,如果不做好文档,往往很难去维护,而且测试环境搭建也需要时间,这时候就需要一款产品可以帮我我们减轻这些工作量了,YAPI 就是这款产品 ,下面给大家讲解其安装方法。

我是 HinGwenWoong,一个有着清晰目标不停奋斗的程序猿,热爱技术,喜欢分享,码字不易,如果帮到您,请帮我在屏幕下方点赞 ,您的点赞可以让技术传播得更远更广,谢谢!

一、什么是 YAPI

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

二、开始部署

我使用的机器是 Centos7,YAPI 需要依赖一下其他的工具链,下面我们一起进行从零到一的安装:

  1. node.js
  2. mongodb
  3. YAPI

2.1 node.js

这里安装的版本是 node-v10.14.1

  1. 下载包(使用淘宝源):

    wget https://npm.taobao.org/mirrors/node/v10.14.1/node-v10.14.1-linux-x64.tar.gz
    

    YAPI 部署从零到一,我都帮你梳理好了_第1张图片

  2. 解压

    tar -xf  node-v10.14.1-linux-x64.tar.gz
    
  3. 重命名文件夹

    mv node-v10.14.1-linux-x64 node
    
  4. 加入变量

    sudo vim /etc/profile
    

    复制下面这段进去

    # node.js
    export NODE_HOME=<你的node文件夹路径>
    export PATH=$NODE_HOME/bin:$PATH
    

    保存并退出

  5. 刷新

    source /etc/profile
    
  6. 测试

    node -v
    npm -v
    

    YAPI 部署从零到一,我都帮你梳理好了_第2张图片

2.2 mongodb

这里安装的版本是 MongoDB 5.0.3

  1. 去到官网获取下载链接:MongoDB Community Server
    YAPI 部署从零到一,我都帮你梳理好了_第3张图片

  2. 下载,我这里的链接下载的是 mongodb-linux-x86_64-rhel70-5.0.3.tgz

    wget https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-rhel70-5.0.3.tgz
    
  3. 解压

    tar zxvf mongodb-linux-x86_64-rhel70-5.0.3.tgz
    
  4. 修改名字

    mv mongodb-linux-x86_64-rhel70-5.0.3 mongodb
    
  5. 加入环境变量

    sudo vim /etc/profile
    

    加入这些:

    # mongodb
    export PATH=<MongoDB 的文件夹路径>/bin:$PATH
    

    保存并退出,刷新缓存

    source /etc/profile
    
  6. 进入MongoDB 的文件夹路径创建必要文件夹 dblog,并修改其权限

    cd <MongoDB 的文件夹路径>
    mkdir db && mkdir log
    chmod 777 db && chmod 777 log
    
  7. 创建配置文件

    touch mongodb.conf
    cd log && touch mongodb.log
    cd ..
    
  8. 修改配置文件

    vim /usr/mongodb/mongodb.conf
    

    加入以下内容

    port=27017                                     #服务的端口号
    dbpath=<MongoDB 的文件夹路径>/db                #数据库存文件存放目录
    logpath=<MongoDB 的文件夹路径>/log/mongodb.log  #日志文件存放路径
    logappend=true                                 #使用追加的方式写日志
    fork=true                                      #以守护进程的方式运行,创建服务器进程
    maxConns=100                                   #最大同时连接数
    journal=true                                   #每次写入会记录一条操作日志(通过journal可以重新构造出写入的数据)。 即使宕机,启动时wiredtiger会先将数据恢复到最近一次的checkpoint点,然后重放后续的journal日志来恢复。
    storageEngine=wiredTiger                       #存储引擎有mmapv1、wiretiger、mongorocks
    bind_ip=0.0.0.0                                #设置0.0.0.0外网才可以访问
    auth=false                                     #校验权限,这是为 true yapi 会链接不上
    
  9. 启动 MongoDB

    mongod --config /usr/mongodb/mongodb.conf
    

    在这里插入图片描述

  10. 如果发现配置配置错了,使用一下命令杀掉进程,然后重新进行第 8

    ps aux |grep mongodb  
    sudo kill <进程ID>
    

2.3 YAPI

YAPI 官网

  1. 官方推荐使用可视化安装,方便快捷

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

  1. 指令

    npm install -g yapi-cli --registry https://registry.npm.taobao.org
    yapi server
    
  2. 使用浏览器登录 IP:9090:
    YAPI 部署从零到一,我都帮你梳理好了_第4张图片
    填写好之后,直接点击【开始部署】即可

  3. 命令行看到这些即为部署完成
    YAPI 部署从零到一,我都帮你梳理好了_第5张图片
    复制下管理员的用户名和密码
    在这里插入图片描述

  4. 按照指示,切换到部署目录,输入: node vendors/server/app.js 指令启动服务器, 然后在浏览器打开 http://127.0.0.1:<安装时候设置的端口号> 访问
    YAPI 部署从零到一,我都帮你梳理好了_第6张图片

  5. 使用刚刚命令行复制的管理员用户名和密码登陆即可
    YAPI 部署从零到一,我都帮你梳理好了_第7张图片

总结

以上就是 YAPI 从零到一的安装方法,希望能够祝你一臂之力。

我是 HinGwenWoong,一个有着清晰目标不停奋斗的程序猿,热爱技术,喜欢分享,码字不易,如果帮到您,请帮我在屏幕下方点赞 ,您的点赞可以让技术传播得更远更广,谢谢!


参考

  • Centos7安装NPM
  • CentOS安装mongodb
  • YAPI内网部署
更多阅读推荐
  • Git | 面试官问你 Git 原理,你能回答得出来吗?
  • CentOS7 升级 Git (最新方法,秒杀一切旧方法!)

授权须知

  1. 原创文章在推送一天后才可进行转载
  2. 转载文章,禁止声明原创
  3. 不允许直接二次转载,转载请根据原文链接联系作者
  4. 若无需改版,在文首清楚标注作者及来源/原文链接,并删除【原创声明】,即可直接转载。
    但对于未注明转载来源/原文链接的文章,我将保留追述的权利。

    作者:HinGwenWoong
    一个有着清晰目标不停奋斗的程序猿,热爱技术,喜欢分享,共同进步!
    CSDN: HinGwenWoong
    原文链接:YAPI 部署从零到一,我都帮你梳理好了

  5. 若需要修改文章的排版,请根据原文链接联系作者
  6. 再次感谢您的认可,转载请遵守如上转载须知!

你可能感兴趣的:(CentOS,Linux,centos,node.js,运维,后端,前端)