centos

centos swagger部署指南

小樊
95
2025-02-14 04:40:15
栏目: 智能运维

在CentOS系统上部署Swagger的指南如下:

准备工作

  1. 安装Node.js和npm
yum install gcc-c make -y
curl -sL https://rpm.nodesource.com/setup_12.x | bash -
yum install nodejs -y
  1. 验证安装
node -v
npm -v

安装Swagger Editor和Swagger UI

  1. 安装Swagger Editor
mkdir /opt/swagger
cd /opt/swagger
wget https://github.com/swagger-api/swagger-editor/archive/v3.14.0.tar.gz
tar -xf v3.14.0.tar.gz
cd swagger-editor-3.14.0
npm install -g http-server
http-server -p 8081

访问 http://172.28.128.20:8081 确认可以访问。

  1. 安装Swagger UI
cd /opt/swagger
wget https://github.com/swagger-api/swagger-ui/archive/v3.34.0.tar.gz
tar -xf v3.34.0.tar.gz
cd swagger-ui-3.34.0
npm init -y
npm install express --save
mkdir public
cp -r swagger-ui-3.34.0/dist/* public/
  1. 创建并修改 index.js
var express = require('express');
var app = express();
var http = require('http');
app.use('/static', express.static('public'));
app.get('/', function (req, res) {
    res.send('Hello World!');
});
app.listen(3000, function () {
    console.log('Example app listening on port 3000!');
});
  1. 启动服务
node index.js

访问 http://172.28.128.20:3000 确认可以访问。

配置Swagger UI显示自定义接口文档

  1. 在Swagger Editor编写接口文档,保存为JSON文件。
  2. 将JSON文件上传至 /opt/swagger/public
  3. 修改 /opt/swagger/public/index.html 中的URL,指向自己的JSON文件。

例如,将 https://petstore.swagger.io/v2/swagger.json 修改为 http://172.28.128.20:3000/static/your-swagger-file.json

  1. 刷新界面即可查看自定义的接口文档。

以上步骤应该可以帮助你在CentOS系统上成功部署Swagger。如果在执行过程中遇到问题,请检查网络连接和防火墙设置,确保相关端口是开放的。

0
看了该问题的人还看了