centos swagger最佳实践

在CentOS上设置和使用Swagger的最佳实践涉及多个步骤，包括安装必要的软件、配置环境、编写API文档以及运行和测试Swagger UI。以下是一个详细的指南：

安装Node.js和npm

首先，你需要在CentOS系统上安装Node.js和npm，这是运行Swagger Editor和Swagger UI的前提条件。

yum install gcc-c make -y
curl -sL https://rpm.nodesource.com/setup_12.x | bash -
yum install nodejs -y

验证安装：

node -v
npm -v

安装Swagger Editor和Swagger UI

接下来，下载并安装Swagger Editor和Swagger UI。

mkdir /opt/swagger
cd /opt/swagger
wget https://github.com/swagger-api/swagger-editor/archive/v3.14.0.tar.gz
tar -xzf v3.14.0.tar.gz
cd swagger-editor-3.14.0
npm install -g http-server
http-server -p 8081 &

访问 http://<your-server-ip>:8081 以确认Swagger Editor是否正常运行。

安装Swagger UI

同样，下载并安装Swagger UI。

cd /opt/swagger
wget https://github.com/swagger-api/swagger-ui/archive/v3.34.0.tar.gz
tar -xzf 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/

编辑 index.js 文件，使其监听3000端口：

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!'); });

启动服务：

node index.js

访问 http://<your-server-ip>:3000 以确认Swagger UI是否正常运行。

配置Swagger文档

在Swagger Editor中编写你的API文档，并将其保存为JSON文件。然后，将这个JSON文件上传到Swagger UI的 public 目录中，并修改 index.html 文件中的URL，以指向你的API文档。

运行和测试Swagger UI

确保你的API服务正在运行，并且可以从Swagger UI中访问。如果遇到CORS问题，需要在你的API服务中设置相应的CORS头部。

注意事项

• 安全性：在生产环境中，确保你的API文档和Swagger UI的安全性，例如通过身份验证和授权机制。
• 性能优化：根据你的需求，对Swagger UI进行性能优化，例如通过缓存和压缩资源。
• 文档更新：确保你的API文档是最新的，并且与实际的API实现保持一致。

以上步骤提供了在CentOS上设置和使用Swagger的基本流程。根据具体的项目需求，你可能需要进一步定制和优化这些步骤。