当前位置: 首页 > news >正文

可视化开源编辑器Swagger Editor本地部署并实现远程访问管理编辑文档

最近,我发现了一个超级强大的人工智能学习网站。它以通俗易懂的方式呈现复杂的概念,而且内容风趣幽默。我觉得它对大家可能会有所帮助,所以我在此分享。点击这里跳转到网站。

文章目录

    • Swagger Editor本地接口文档公网远程访问
    • 1. 部署Swagger Editor
    • 2. Linux安装Cpolar
    • 3. 配置Swagger Editor公网地址
    • 4. 远程访问Swagger Editor
    • 5. 固定Swagger Editor公网地址

Swagger Editor本地接口文档公网远程访问

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://www.cpolar.com

  • 使用一键脚本安装命令
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

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界面!!

外链图片转存中…(img-3bvMtpPA-1698892164951)]

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

image-20231102094839847

http://www.lryc.cn/news/254158.html

相关文章:

  • Java TCP协议实现一对一聊天与UDP协议实现群聊案例
  • 【从0配置JAVA项目相关环境1】jdk + VSCode运行java + mysql + Navicat + 数据库本地化 + 启动java项目
  • 人工智能_机器学习053_支持向量机SVM目标函数推导_SVM条件_公式推导过程---人工智能工作笔记0093
  • 二叉树的前、中和后序遍历的递归与迭代实现
  • 人体姿态估计算法
  • docker部署jupyter
  • 音视频的功耗优化
  • Python实现FA萤火虫优化算法优化XGBoost回归模型(XGBRegressor算法)项目实战
  • SCAUoj综合性实验
  • 智加科技获全国首张重卡无人驾驶开放道路测试牌照
  • LLM大语言模型(一):ChatGLM3-6B本地部署
  • chatgpt prompt提示词
  • 【PyTorch】数据集
  • oops-framework框架 之 本地存储(五)
  • 编程常见的问题
  • 针对Arrays.asList的坑,可以有哪些处理措施
  • SE考研真题总结(一)
  • Xshell远程登录AWS EC2 Linux实例
  • Elasticsearch:对时间序列数据流进行降采样(downsampling)
  • python自动化测试框架:unittest测试用例编写及执行
  • ctfhub技能树_web_web前置技能_HTTP
  • mysql8报sql_mode=only_full_group_by(存储过程一直报)
  • Vue2中v-html引发的安全问题
  • java内部类详解
  • Python 潮流周刊#29:Rust 会比 Python 慢?!
  • 吴恩达《机器学习》11-1-11-2:首先要做什么、误差分析
  • Pandas在Excel同一个sheet里插入多个Dataframe和行
  • 查看mysql 或SQL server 的连接数,mysql超时、最大连接数配置
  • C++学习之路(七)C++ 实现简单的Qt界面(消息弹框、按钮点击事件监听)- 示例代码拆分讲解
  • python实现一个计算器