在Linux系統上,Swagger工具鏈主要包括Swagger UI和Swagger Editor。以下是推薦的安裝和使用方法:
sudo apt update
sudo apt install -y openjdk-11-jre-headless
wget https://repo1.maven.org/maven2/io/springfox/springfox-swagger-ui/2.9.2/springfox-swagger-ui-2.9.2.html
unzip springfox-swagger-ui-2.9.2.html
/var/www/html
):sudo mv springfox-swagger-ui-2.9.2 /var/www/html/swagger-ui
/var/www/html/swagger-ui/index.html
文件,找到以下行并進行修改:script window.onload function () {
// Begin Swagger UI call region
const ui = SwaggerUIBundle({
url: "http://petstore.swagger.io/v2/api-docs",
dom_id: '#swagger-ui',
deepLinking: true,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout"
});
// End Swagger UI call region
window.ui = ui;
};
sudo a2ensite default.confsudo systemctl restart apache2
sudo cp /etc/nginx/sites-available/default /etc/nginx/sites-available/default.baksudo nano /etc/nginx/sites-available/default
修改 server
塊中的 root
和 index
指令:
server {
listen 80 default_server;
listen [::]: 80 default_server;
root /var/www/html;
index index.html index.htm;
server_name _;
location / {
try_files $uri $uri/ =404;
}
}
保存并退出編輯器,然后重啟Nginx:
sudo systemctl restart nginx
wget https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.50.0/swagger-editor.min.js
wget https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.50.0/swagger-editor.min.css
/var/www/html
):sudo mv swagger-editor.min.js /var/www/html/swagger-editor.js
sudo mv swagger-editor.min.css /var/www/html/swagger-editor.css
sudo nano /var/www/html/swagger-editor.html
添加以下內容:
!DOCTYPE html>
html
head
link rel "stylesheet" type "text/css" href "swagger-editor.css"
/head
body
div id "swagger-editor">
/div
script src "swagger-editor.js"
/script
script window.onload function () {
const editor = SwaggerEditor({
url: "https://petstore.swagger.io/v2/api-docs",
dom_id: '#swagger-editor'
});
};
/script
/body
/html
sudo a2ensite default.confsudo systemctl restart apache2
sudo cp /etc/nginx/sites-available/default /etc/nginx/sites-available/default.baksudo nano /etc/nginx/sites-available/default
修改 server
塊中的 root
和 index
指令:
server {
listen 80 default_server;
listen [::]: 80 default_server;
root /var/www/html;
index index.html index.htm;
server_name _;
location / {
try_files $uri $uri/ =404;
}
}
保存并退出編輯器,然后重啟Nginx:
sudo systemctl restart nginx
現在,你應該能夠通過瀏覽器訪問 http://your_server_ip/swagger-ui
和 http://your_server_ip/swagger-editor
來查看和使用Swagger UI和Swagger Editor。
請注意,以上信息僅供參考,具體配置步驟可能因你的Linux發行版和Swagger集成方式的不同而有所變化。在生產環境中部署Swagger之前,請確保進行充分的測試,并根據你的具體環境進行相應的配置。