Swagger API如何在Linux中測試

在Linux系統中測試Swagger API，可以按照以下步驟進行：

安裝Swagger

• 使用Docker：

  1. 安裝Docker：

     sudo apt-get update
     sudo apt-get install -y docker.io
     sudo systemctl start docker
     sudo systemctl enable docker
     

  2. 拉取并運行Swagger Editor：

     docker pull swaggerapi/swagger-editor:v4.6.0
     docker run -d -p 38080:8080 swaggerapi/swagger-editor:v4.6.0
     

  3. 拉取并運行Swagger UI：

     docker pull swaggerapi/swagger-ui:v4.15.5
     docker run -d -p 38081:8080 swaggerapi/swagger-ui:v4.15.5
     

配置和使用Swagger

• 導入Swagger配置文件：
  • 打開Swagger Editor（http://localhost:38080），點擊左上角的【File】-【Import File】，選擇你的swagger.json或swagger.yaml文件進行導入。
• 測試API接口：
  • 在Swagger UI界面中，瀏覽到相應的API接口，點擊“TRY IT OUT”按鈕，輸入必要的參數，發送請求并查看返回結果，以驗證API是否按預期工作。

注意事項

• 確保Swagger UI容器正在運行，并且端口映射正確。
• 如果需要對Swagger UI進行安全配置，如添加密碼保護，可以參考相關文檔。

其他測試方法

• 使用cURL命令行工具：

  curl -X GET "http://api.example.com/users" -H "accept: application/json"
  curl -X POST "http://api.example.com/users" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"username":"testuser","email":"test@example.com"}'
  

• 使用HTTPie（更友好的命令行HTTP客戶端）：

  sudo apt install httpie  # Ubuntu/Debian
  sudo dnf install httpie # Fedora
  sudo pacman -S httpie   # Arch Linux
  http GET http://api.example.com/users
  http POST http://api.example.com/users username=testuser email=test@example.com
  

• 使用Postman：
  • 下載Postman Linux版本并安裝。
  • 導入Swagger/OpenAPI規范文件，創建并發送請求。
• 使用Insomnia：
  • 在Ubuntu/Debian：

    sudo snap install insomnia
    

  • 或者使用AppImage：

    wget https://github.com/Kong/insomnia/releases/download/core%402021.5.0/Insomnia.Core-2021.5.0.AppImage
    chmod +x Insomnia.Core-2021.5.0.AppImage
    ./Insomnia.Core-2021.5.0.AppImage
    

• 使用Swagger Codegen生成客戶端：

  wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.25/swagger-codegen-cli-3.0.25.jar -O swagger-codegen-cli.jar
  java -jar swagger-codegen-cli.jar generate \
    -i http://petstore.swagger.io/v2/swagger.json \
    -l python \
    -o /tmp/python-client
  

通過以上步驟，你可以在Linux系統上成功部署和使用Swagger進行API測試。