Ubuntu如何利用Swagger進行API文檔管理

在Ubuntu上利用Swagger進行API文檔管理，通常涉及以下幾個步驟：

安裝Swagger Editor和Swagger UI

1. 安裝必要的系統工具：

sudo apt-get update
sudo apt-get install apt-transport-https ca-certificates curl software-properties-common

2. 安裝GPG證書：

curl -fsSL https://mirrors.aliyun.com/docker-ce/linux/ubuntu/gpg | sudo apt-key add -

3. 寫入軟件源信息：

echo "deb [archamd64] https://mirrors.aliyun.com/docker-ce/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker-ce.list

4. 更新并安裝Docker CE：

sudo apt-get update
sudo apt-get install -y docker-ce

5. 檢查Docker是否安裝成功：

sudo docker run hello-world

6. 下載并運行Swagger Editor和Swagger UI的Docker容器：

• Swagger Editor：

docker pull swaggerapi/swagger-editor
docker run -d -p 8080:8080 swaggerapi/swagger-editor

• Swagger UI：

docker pull swaggerapi/swagger-ui
docker run -p 80:8080 -e SWAGGER_JSON=/foo/swagger.json -v /path/to/your/swagger.json:/foo swaggerapi/swagger-ui

使用Swagger Editor和Swagger UI

• Swagger Editor：可以通過訪問http://localhost:8080在線使用，或者下載Swagger Editor的源碼并在本地運行。
• Swagger UI：通過訪問http://localhost:80在線使用，或者下載Swagger UI的源碼并在本地運行。如果需要使用本地JSON文件，可以在運行Swagger UI容器時通過-e SWAGGER_JSON=/foo/swagger.json參數指定JSON文件的路徑。

注意事項

• 在運行Swagger Editor和Swagger UI容器時，可能會遇到端口占用的問題?？梢允褂?code>netstat -lnpgrep 80命令檢查端口是否被占用，并結束相應進程。
• 如果需要在容器外部修改API文檔，可以在外部修改后重新構建并運行容器，或者在容器內部進行修改后，將修改后的文件保存到容器內的指定位置。

以上步驟可以幫助你在Ubuntu系統上成功安裝并運行Swagger Editor和Swagger UI，從而進行API文檔的管理。