首页 > 系统相关 >Linux(CentOS)部署 y-api 接口管理平台

Linux(CentOS)部署 y-api 接口管理平台

时间:2024-04-05 21:33:11浏览次数:26  
标签:node CentOS yapi 接口 api 文档 usr Linux local

目录

前言

前置环境

mongodb

node

安装 y-api

部署页面

启动 y-api

基本使用教程


前言

前后端分离时代,前后端通过接口文档来协作开发项目。一般开发过程中,由后端先编写接口文档,然后交付给前端,这时候前后端都根据这个编写的接口文档来进行开发。在没有一个统一的接口管理平台下,仅用一个文档作为前后端团队协作的媒介,一旦出现需求变更或者开发过程发现接口设计不合理需要重新调整,就需要改动接口文档,每次改动需要重新发一个文档给前端,改动次数越多,就会造成文档越混乱,同时也会出现前端对着旧版的接口文档开发的情况。

针对以上问题,可以使用 y-api 接口管理平台来管理,前后端不直接对接,而是通过接口管理平台来沟通。后端在平台写接口文档,前端在平台看接口文档,后端对接口文档的每次调整,前端都能够及时看到,确保了前后端看的接口都是同一份版本。可以减少前后端沟通的成本,有效提高开发效率。

前置环境

mongodb

如果没有安装mongodb,可参考:

Linux(CentOS7)安装 MongoDB-CSDN博客icon-default.png?t=N7T8https://blog.csdn.net/typeracer/article/details/137157993?spm=1001.2014.3001.5501

node

下载 node 包,这里指定版本 12.12.0,其他版本可能会出现问题

进入 /usr/local/ 目录

cd /usr/local

下载 node 12 的包

wget https://npm.taobao.org/mirrors/node/v12.12.0/node-v12.12.0-linux-x64.tar.xz

解压

tar -xvf node-v12.12.0-linux-x64.tar.xz

创建软链接,这样在任意目录便能够使用以下命令

ln -s -f /usr/local/node-v12.12.0-linux-x64/bin/node /usr/local/bin/node
ln -s -f /usr/local/node-v12.12.0-linux-x64/bin/npm /usr/local/bin/npm
ln -s -f /usr/local/node-v12.12.0-linux-x64/bin/npx /usr/local/bin/npx

安装 y-api

安装 yapi-cli

npm install -g yapi-cli --registry https://registry.npmmirror.com

进入 bin 文件,执行 yapi server

cd bin

./yapi server

部署页面

浏览器访问服务器 9090 端口

自定义配置,这里选了最新的部署版本

注意:原域名 https://registry.npm.taobao.org 在 2022.06.30 号正式下线和停止 DNS 解析 

所以部署会出现以下错误

新的淘宝镜像域名为 https://registry.npmmirror.com 

需要修改安装目录下 lib/node_modules/yapi-cli/src/commands/install.js 文件

将其中的 https://registry.npm.taobao.org 换成 https://registry.npmmirror.com 

 然后重启 yapi server,再次部署,就能够正常下载依赖,最后成功部署

启动 y-api

进入 my-yapi 目录,执行 node vendors/server/app.js

cd my-yapi

node vendors/server/app.js

访问

基本使用教程

添加项目

添加接口

编辑接口

分组权限

标签:node,CentOS,yapi,接口,api,文档,usr,Linux,local
From: https://blog.csdn.net/typeracer/article/details/137395292

相关文章

  • 小程序开发必备:常用原生API指南及Vue对比
    作为一个成熟的应用开发平台,微信小程序除了提供基本的网络请求API外,还为开发者开放了大量其他原生功能,涵盖界面跳转、设备信息获取、支付等多个领域。熟练掌握这些小程序原生API的使用,能够帮助我们更好地发挥小程序的能力,构建出功能丰富、用户体验优秀的应用。在本文......
  • 【Linux】Linux调试器-gdb使用
    个人主页:zxctscl如有转载请先通知文章目录1.前言2.调试前准备3.使用3.1进入gdb3.2list3.3run3.4与断点有关操作3.4.1b打断点3.4.2info显示断点位置3.4.3d去断点3.4.4disable使能3.5next/n逐过程3.6step/s逐语句3.7print/p查看变量内容及地址3.8dis......
  • Linux之信号
    1.常见信号虽然最开始的编号是1,最后的编号是64,但是并不是有64个信号,没有32和33号信号,也就是说,一共有62个信号,前31个信号是标准信号(非实时信号),后31个信号是实时信号。上边的这些信号,各自会在什么条件下产生,默认处理动作是什么,都有在signal(7)中有详细说明,对应的命令是:man......
  • 嵌入式Linux驱动开发-第一个驱动程序hello
    前言,没事就碎碎念以前跟着正点原子的文档做过一两个简单驱动程序实验,但是总感觉思路不够清晰,后面看韦东山的视频,发现二者结合起来刚好合适,其中韦东山视频理论和框架讲的清楚,正点原子的更像是他们开发板的使用手册。一开始学习驱动,我感觉比较合适的路线是先简单过一遍裸机,跟着正......
  • DSL - Wire 实现-ApiHug101
      ......
  • DSL - Stub - 实现-ApiHug101
     ......
  • 五分钟玩转ApiHug-ApiHug101
       ......
  • Linux gunzip命令教程:如何使用gunzip命令进行文件解压缩(附实例详解和注意事项)
    Linuxgunzip命令介绍gunzip是一个用于解压缩文件的命令行工具。它可以接受所有以.gz、.z、_z、-gz、-z、.Z、.taz或.tgz为扩展名的文件,并默认将压缩文件替换为原始文件。解压后的文件保留其实际扩展名。Linuxgunzip命令适用的Linux版本gunzip命令在大多数Linux发行版中......
  • Linux ulimit命令教程:如何查看和设置系统资源限制(附实例详解和注意事项)
    Linuxulimit命令介绍ulimit是一个内置的Linuxshell命令,它允许查看或限制单个用户可以消耗的系统资源量。在有多个用户和系统性能问题的环境中,限制资源使用是非常有价值的。Linuxulimit命令适用的Linux版本ulimit命令在所有主流的Linux发行版中都是可用的,包括Debian、U......
  • linux 搭建Samba服务
    Samba简介SAMBA是⼀个实现不同操作系统之间⽂件共享和打印机共享的⼀种SMB协议的免费软件,SMB(ServerMessageblock)协议是window下所使⽤的⽂件共享协议,我们在linux系统或者其类unix系统当中可以通过samba服务来实现SMB功能。(1)在⽹络上共享⽬录,决定访问权限;(2)在⽹络上共享......