首页 > 系统相关 >Linux 部署 Swagger Editor 接口文档并且实现远程访问教程

Linux 部署 Swagger Editor 接口文档并且实现远程访问教程

时间:2023-11-16 09:59:01浏览次数:39  
标签:Linux cpolar 访问 域名 Editor 公网 Swagger

Swagger Editor是一个用于编写OpenAPI规范的开源编辑器。它提供了一个可视化的界面,使得用户可以更加方便地编写和管理API文档。

Swagger Editor 远程访问的好处是您可以随时随地访问和编辑您的 Swagger API 文档,而不需要在本地安装 Swagger 编辑器。此外 还可以轻松地与团队成员共享和协作编辑 Swagger API 文档,以确保文档的实时更新和一致性

下面介绍使用Docker 安装部署Swagger Editor并且结合Cpolar 内网穿透工具实现远程访问,当然,这里是方便演示,所以在docker安装,有些在项目中已经集成了,也是一样的设置远程方式的方法.

 

1. 部署Swagger Editor

Docker 简单几步即可运行,简化了繁琐的安装步骤,首先拉取Swagger Editor 容器

docker pull swaggerapi/swagger-editor

 

运行容器,其中把容器的8080端口映射到宿主机的8088,这个端口可以自定义

docker run  -p 8088:8080 -d swaggerapi/swagger-editor

 

运行后,在本地浏览器访问Linux 8088端口,即可看到Swagger Editor 界面,本地部署就成功了,下面我们安装cpolar内网穿透工具,实现远程访问!

image-20231101173304100

 

2. Linux安装Cpolar

上面在本地Docker中成功部署了Swagger Editor,并局域网访问成功,下面我们在Linux安装cpolar内网穿透工具,通过cpolar 转发本地端口映射的http公网地址,我们可以很容易实现远程访问,而无需自己注册域名购买云服务器.下面是安装cpolar步骤

cpolar官网地址: https://i.cpolar.com/m/4Y6w

  • 使用一键脚本安装命令

curl -L https://www.cpolar.com/static/downloads/install-release-cpolar.sh | sudo bash

 

  • 向系统添加服务

sudo systemctl enable cpolar

 

  • 启动cpolar服务

sudo systemctl start cpolar

cpolar安装成功后,在外部浏览器上访问Linux 的9200端口 即:【http://局域网ip:9200】,使用cpolar账号登录(如没有账号,可以点击下面免费注册),登录后即可看到cpolar web 配置界面,结下来在web 管理界面配置即可

image-20231016143741228

3. 配置Swagger Editor公网地址

点击左侧仪表盘的隧道管理——创建隧道,创建一个Swagger Editor 的公网地址隧道!

  • 隧道名称:可自定义命名,注意不要与已有的隧道名称重复

  • 协议:选择http

  • 本地地址:8088 (本地访问的端口号)

  • 域名类型:免费选择随机域名

  • 地区:选择China

点击创建

image-20231102093609424

隧道创建成功后,点击左侧的状态——在线隧道列表,查看所生成的公网访问地址,有两种访问方式,一种是http 和https

image-20231102093645794

4. 远程访问Swagger Editor

使用上面的cpolar https公网地址,在任意设备的浏览器进行访问,即可成功看到我们Swagger Editor界面,这样一个公网地址且可以远程访问就创建好了,使用了cpolar的公网域名,无需自己购买云服务器,即可发布到公网进行远程访问 !

image-20231102093921549

5. 固定Swagger Editor公网地址

由于以上使用cpolar所创建的隧道使用的是随机公网地址,24小时内会随机变化,不利于长期远程访问。因此我们可以为其配置二级子域名,该地址为固定地址,不会随机变化【ps:cpolar.cn已备案】

注意需要将cpolar套餐升级至基础套餐或以上,且每个套餐对应的带宽不一样。【cpolar.cn已备案】

登录cpolar官网,点击左侧的预留,选择保留二级子域名,设置一个二级子域名名称,点击保留,保留成功后复制保留的二级子域名名称

image-20231102094424678

保留成功后复制保留成功的二级子域名的名称

image-20231102094535340

返回登录cpolar web UI管理界面,点击左侧仪表盘的隧道管理——隧道列表,找到所要配置的隧道,点击右侧的编辑

image-20231102094717014

修改隧道信息,将保留成功的二级子域名配置到隧道中

  • 域名类型:选择二级子域名

  • Sub Domain:填写保留成功的二级子域名

点击更新(注意,点击一次更新即可,不需要重复提交)

image-20231102094743380

更新完成后,打开在线隧道列表,此时可以看到公网地址已经发生变化,地址名称也变成了固定的二级子域名名称的域名

image-20231102094803678

最后,我们使用固定的公网地址访问,可以看到访问成功,这样一个固定且永久不变的公网地址就设置好了,随时随地都可以远程访问Swagger Editor界面!!

 
image-20231102094839847

标签:Linux,cpolar,访问,域名,Editor,公网,Swagger
From: https://www.cnblogs.com/flzidea/p/17835497.html

相关文章

  • Linux 本地AMH 服务器管理面板实现远程访问方法
    AMH是一款基于Linux系统的服务器管理面板,它提供了一系列的功能,包括网站管理、FTP管理、数据库管理、DNS管理、SSL证书管理等。使用AMH云主机面板可以方便地管理服务器,提高工作效率。AMH面板远程访问的好处在于,用户可以通过互联网远程登录到服务器主机面板,方便地管理和维......
  • Linux 中 echo 命令 将字体输出颜色
     001、示例(base)[root@pc1test]#echo-e"\033[47;30mxxxxx\033[0m"##47表示背景色;30表示字体颜色xxxxx 002、取消背景色(base)[root@pc1test]#echo-e"\033[30mxxxxx\033[0m"##取消背景色,字体为黑色xxxxx(base)[root@pc1test]#echo......
  • linux
    一、目录操作命令:切换目录:cdcd/#切换到根目录cd~#切换到主目录cd-#切换到上次访问的目录cd..#返回上一级目录查看目录:ls和pwd:pwd查看当前工作路径(绝对路径)ls查看当前目录下的目录和文件命令格式:ls[-选项]目录名选项:   -a:列出当前目录......
  • selinux的上下文
    一:了解selinux的信息selinux和防火墙和文件和目录的权限三种限制要开启一个服务,这三个东西都要调试一下,才能正确的使用这个服务selinux的介绍:他是一个安全访问策略,用来确定进程可以访问哪些文件,服务对应的文件或者目录,服务对应的端口,服务对应的进程这三种列子:服务的实列(就......
  • Linux设备树(DTS)介绍
    Dts:DTS即DeviceTreeSource,是一个文本形式的文件,用于描述硬件信息。一般都是固定信息,无法变更,无法overlay。设备树由来linux内核源码中,之前充斥着大量的平台相关(platformDevice)配置,而这些代码大多是杂乱且重复的,这使得ARM体系结构的代码维护者和内核维护者在发布一个新的版本的时......
  • 如何在 Linux 上部署 RabbitMQ
    如何在Linux上部署RabbitMQ目录如何在Linux上部署RabbitMQ安装Erlang从预构建的二进制包安装从源代码编译ErlangRabbitMQ的安装使用RabbitMQAssistant连接RabbitMQAssistant是一款优秀的RabbitMQ可视化管理工具,提供丰富的管理功能。下载地址:https://www.redisan......
  • Linux操作系统优化 I/O调度,透明大页,swap,NUMA
    I/O调度的4种算法对于固态硬盘来说使用NOOP是最好的,DeadLine次之,而CFQ效率最低。CFQ(完全公平排队I/O调度程序)特点:在最新的内核版本和发行版中,都选择CFQ做为默认的I/O调度器,对于通用的服务器也是最好的选择.CFQ试图均匀地分布对I/O带宽的访问,避免进程被饿死并实现较低的延迟,......
  • Linux系统Keepalive Nginx做前置机配置
     1、软件官网下载https://www.keepalived.org/download.htmlhttp://nginx.org/download/选择软件版本如下[root@ZE-NGXFR01data]#lltotal1960-rw-------1sysadmsysadm927631Nov1510:34keepalived-2.0.10.tar.gz-rw-------1sysadmsysadm1073322Nov1511:01......
  • Linux管理员密码恢复
    Linux管理员密码恢复在大多数的linux中在GRUB界面按下e键,进入启动命令编辑模式,在这里一般有下面这三行东西: 其中:第一行root行表示了指定根目录为哪个盘那个分区第二行kernel行表示了要加载的内核文件第三行initrd行表示了指定要加载的初始内存文件系统文件,用于在启动过程中......
  • putty连接linux时慢
    情况描述:putty连接rhel6/7时输入用户可能会等待10-30秒才有提示输入密码解决办法:vi/etc/ssh/sshd_config###找到GSSAPIAuthenticationyes,修改为GSSAPIAuthenticationno###注意,这里你也需要将UseDNS修改为no,CentOS默认是yes,即使这行已被注释,你也需要加上UseDNSno ......