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的基本流程。根據具體的項目需求，你可能需要進一步定制和優化這些步驟。