linux

Swagger在Linux上如何部署API

小樊
39
2025-04-07 02:52:18
栏目: 智能运维

在Linux上部署Swagger以管理和测试API文档,可以按照以下步骤进行:

部署Swagger Editor

  1. 拉取Swagger Editor Docker镜像
docker pull swaggerapi/swagger-editor
  1. 运行容器并映射端口
docker run -p 8088:8080 -d swaggerapi/swagger-editor

这会将容器的8080端口映射到宿主机的8088端口,在本地浏览器访问http://localhost:8088即可看到Swagger Editor界面。

部署Swagger UI

  1. 安装Node.js和npm
wget https://nodejs.org/dist/v14.17.0/node-v14.17.0-linux-x64.tar.xz
tar -xf node-v14.17.0-linux-x64.tar.xz
cd node-v14.17.0-linux-x64
sudo ln -s /usr/local/bin/node /usr/bin/node
sudo ln -s /usr/local/bin/npm /usr/bin/npm
  1. 安装Express和其他必要的模块
npm install express body-parser cookie-parser multer
  1. 配置Express应用: 在node_app目录下创建public文件夹,将Swagger UI的dist文件夹内容复制到public文件夹中,并修改index.js文件以提供Swagger UI文档:
var express = require('express');
var app = express();
app.use('/swagger', express.static('public'));
app.listen(3000, function () {
    console.log("Server started at http://localhost:3000");
});
  1. 启动Express服务器
node index.js

访问http://your_server_ip:3000即可看到Swagger UI。

配置远程访问

  1. 安装Cpolar内网穿透工具
curl -L https://www.cpolar.com/static/downloads/install-release-cpolar.sh | sudo bash
sudo systemctl enable cpolar
sudo systemctl start cpolar
  1. 配置Swagger Editor公网地址: 在Swagger Editor中创建隧道,配置公网地址,使用Cpolar生成的公网地址进行远程访问。

使用Docker安装Swagger

  1. 拉取Swagger Editor镜像
docker pull swaggerapi/swagger-editor
  1. 运行容器
docker run -p 8080:8080 -d swaggerapi/swagger-editor
  1. 访问Swagger Editor: 在浏览器中访问http://your_server_ip:8080即可使用Swagger Editor。

通过以上步骤,您可以在Linux系统上成功部署Swagger Editor和Swagger UI,并实现远程访问,以便于团队协作和API文档管理。

0
看了该问题的人还看了