在Linux系統中部署Swagger的流程如下:
Swagger需要Java運行環境(JRE)或Java開發工具包(JDK)。你可以通過以下命令安裝OpenJDK:
sudo apt update
sudo apt install openjdk-11-jdk
驗證安裝:
java -version
Swagger使用Maven進行構建和依賴管理。你可以通過以下命令安裝Maven:
sudo apt install maven
驗證安裝:
mvn -version
你可以從Swagger的官方GitHub倉庫克隆Swagger UI項目:
git clone https://github.com/swagger-api/swagger-ui.git
cd swagger-ui
使用Maven構建Swagger UI項目:
mvn clean install
將構建好的Swagger UI文件復制到你的Web服務器目錄中,例如 /var/www/html:
sudo cp -r target/swagger-ui-dist/* /var/www/html/
/etc/apache2/sites-available/swagger.conf:<VirtualHost *:80>
ServerName localhost
DocumentRoot /var/www/html
Directory /var/www/html
Options Indexes FollowSymLinks AllowOverride All Require all granted
</VirtualHost>
sudo a2ensite swagger.conf
sudo systemctl reload apache2
/etc/nginx/sites-available/swagger:server {
listen 80;
server_name localhost;
root /var/www/html;
index index.html index.htm;
location / {
try_files $uri $uri/ /index.html;
}
}
sudo ln -s /etc/nginx/sites-available/swagger /etc/nginx/sites-enabled/
sudo nginx -t
sudo systemctl reload nginx
確保你的Web服務器(如Apache或Nginx)已經啟動并運行。
打開瀏覽器,訪問 http://your_server_ip/swagger-ui,你應該能夠看到Swagger UI的歡迎頁面。
如果你希望使用Docker來部署Swagger Editor,可以按照以下步驟進行:
docker pull swaggerapi/swagger-editor:v4.6.0
將容器的8080端口映射到宿主機的8088端口:
docker run -d -p 8088:8080 swaggerapi/swagger-editor:v4.6.0
運行后,在本地瀏覽器訪問 http://your_server_ip:8088,即可看到Swagger Editor界面。
通過以上步驟,你就可以在Linux系統中成功部署Swagger,并使用Swagger Editor進行API文檔的編寫和管理。