Skip to content

feat: upgrade to Swagger UI 5.30.2 and unify URL parameter#3

Merged
min0625 merged 2 commits into
mainfrom
release/develop
Nov 4, 2025
Merged

feat: upgrade to Swagger UI 5.30.2 and unify URL parameter#3
min0625 merged 2 commits into
mainfrom
release/develop

Conversation

@min0625

@min0625 min0625 commented Nov 4, 2025

Copy link
Copy Markdown
Owner

📝 變更摘要

本次更新將 Swagger UI 升級至 5.30.2 版本,修復了處理 Petstore OpenAPI 3.x 規格時的渲染錯誤,並統一使用 url 作為參數名稱,提升整體使用體驗。

✨ 主要變更

版本升級

  • Swagger UI: 5.10.0 → 5.30.2
    • 修復 OpenAPI 3.x 版本欄位驗證問題
    • 改善對 https://petstore3.swagger.io/api/v3/openapi.json 的相容性

功能調整

  • 統一參數名稱: 從 ?uri= 改為 ?url=

    • 更符合直覺的命名
    • 統一系統內所有參數引用
  • 簡化架構: 移除 CORS Proxy 功能

    • 只保留直連載入方式
    • 降低複雜度,提升穩定性
  • 改善使用體驗:

    • 新增載入指示器(Loading indicator)
    • 優化錯誤訊息顯示

程式碼優化

  • ✅ 移除測試檔案,保持專案簡潔
    • 刪除 compare.html
    • 刪除 index-new.html
    • 刪除 index-simple.html
    • 刪除 test.html
    • 刪除 test-latest.html

文件更新

  • ✅ 更新 README.md(英文版)
  • ✅ 更新 README.zh-TW.md(繁體中文版)
  • ✅ 修正 GitHub Raw URL 格式範例
  • ✅ 移除過時的 CORS Proxy 說明

🧪 測試

已在本機測試以下情境:

  • ✅ Petstore OpenAPI 3.0 載入成功
  • ✅ Petstore Swagger 2.0 載入成功
  • ✅ 預設範例(無參數)正常運作
  • ✅ GitHub Raw URL 正常載入

📚 使用範例

新的使用方式

https://min0625.github.io/openapi-viewer?url=https://petstore3.swagger.io/api/v3/openapi.json

舊的使用方式(已移除)

❌ ?uri= (不再支援)

🔄 Breaking Changes

⚠️ 重要: 參數名稱從 uri 改為 url

  • 如果有外部連結使用 ?uri=,需要更新為 ?url=
  • 建議更新所有書籤和文件中的連結

📋 檔案變更

  • index.html - 主要程式碼更新
  • README.md - 英文文件更新
  • README.zh-TW.md - 繁體中文文件更新
  • 刪除 5 個測試用 HTML 檔案

cc @min0625

- Upgrade Swagger UI from 5.10.0 to 5.30.2 to fix OpenAPI 3.x rendering issues
- Unify parameter name from 'uri' to 'url' for consistency
- Remove CORS proxy functionality (direct loading only)
- Remove all test HTML files (compare.html, index-new.html, index-simple.html, test.html, test-latest.html)
- Add loading indicator for better UX
- Update documentation (README.md & README.zh-TW.md) to reflect changes
- Fix GitHub Raw URL format in examples
@min0625 min0625 merged commit 28725b2 into main Nov 4, 2025
3 checks passed
@min0625 min0625 deleted the release/develop branch November 4, 2025 18:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant