一、今天要達成什麼
在正式發佈之前，需要檢查所有的資料和設定，確保一切正確無誤。今天我想要確保所有的 API 檢查項目都符合標準並準備好進行上線。
二、檢查項目清單

1. API 金鑰不外流
   確認 API 金鑰沒有直接寫在程式碼中，特別是提交到 GitHub 等公開平台時。可以使用環境變數或秘密管理工具（如 AWS Secrets Manager、Azure Key Vault、HashiCorp Vault）來儲存 API 金鑰。驗證 API 金鑰和密碼保護是否符合安全要求，並進行定期輪換。
2. API 註解與說明檔完整
   檢查 API 文件是否完整，所有端點、請求格式、回應格式、錯誤訊息以及狀態碼是否都已經清楚地描述。
   確保每一個端點的功能和使用方式都有詳細的說明，並提供實際的例子。
   這可以幫助 API 使用者理解如何調用和處理 API，減少未來的維護成本。
3. API 錯誤訊息格式
   確保錯誤訊息的格式一致並且對開發者友好。例如，錯誤訊息應該包含：
   • 錯誤碼：用來標識錯誤的唯一編號。
   • 錯誤描述：簡潔明瞭的錯誤描述，幫助開發者理解問題。
   • 建議解決方法：如「請檢查輸入的參數是否正確」等提示。
   • 錯誤範例：如果有可能，提供錯誤的範例。
   這樣可以讓開發者更容易排查錯誤，並且提高 API 的易用性。
4. API 授權與權限控制
   確保只有授權的用戶可以訪問 API，並且設置適當的權限。
   如果 API 需要身份驗證，檢查 API 是否正確配置了 OAuth2、API 金鑰或其他身份驗證機制。
   確保用戶的權限限制符合業務需求，例如只允許某些用戶訪問敏感資料。
5. 版本控制和升級管理
   確保 API 的版本控制清晰，並標記了所有端點的版本，這樣使用者在升級時能夠避免不兼容的變更。
   在 API 文件中清楚列出版本更新的內容，並明確指出何時停止對舊版本的支持。
   三、測試計劃與上線檢查
6. 測試案例回顧
   檢查所有測試案例是否已經涵蓋到邊界情況、錯誤情況、異常情況及成功案例。
   回顧並執行 API 測試，確保 API 在不同情境下都能正常工作。
7. API 性能測試
   測試 API 在高負載情況下的表現，確保它能夠處理高併發請求並保持穩定。
   如果需要，進行壓力測試，查看 API 是否能夠持續運行而不崩潰。
8. 監控與日誌設置
   確保已經設置 API 日誌系統，並能夠追蹤請求、錯誤、性能等關鍵指標。
   配置實時監控，能夠迅速發現問題並進行調整。
9. 測試用戶反饋
   通常會請團隊成員或早期用戶來進行最後的測試，並根據反饋進行修正。若有需要，確保他們的反饋能夠被有效回應。
   四、準備發佈
10. 版本號標記
    確保 API 版本號已經標明，並且可以追溯，從而避免任何模糊性或混淆。
11. 部署腳本和自動化
    確保部署腳本已經準備好並能夠自動化整個部署過程，避免手動操作導致的錯誤。
    測試部署流程，確保在新版本上線時沒有問題。
12. 通知使用者與團隊
    發佈前，通知相關人員，包括內部開發團隊和外部 API 使用者，讓他們準備好適應新版本的變更。
    五、今日說明
    本日進行了 API 發佈前的全面檢查，主要檢查項目包括金鑰安全、API 註解與錯誤訊息格式、授權與權限控制、版本控制等。
    完成測試案例回顧，確保 API 能夠正確運行並應對高負載情況。
    上線準備工作包括部署腳本、通知使用者、以及測試用戶反饋，確保最終發佈無誤。