ADP 網站: BETA 版 & 徵求意見稿

v1.0.0 發布目標: 2024年8月31日

本網站目前正在建設中。數個 ADP 正在等待審核和完善。部分文章標記為 佔位符 或 草稿。

徵求意見稿聯絡人: alive.kuo@vivotek.com

待辦事項清單

API 文件版本控制

實施 API 文件的版本控制，以與 API 版本保持一致。
清楚標示每套文件對應的 API 版本。
考慮使用支持文件版本控制與代碼版本控制並行的工具。

多語言 API 文件

提供創建和維護多語言 API 文件的指南。
根據目標受眾和業務需求優先考慮語言。
確保不同語言版本的文件之間保持一致性。

API 變更通知機制

建立正式流程，通知 API 使用者重大變更。
對變更進行分類（如破壞性、非破壞性、棄用），並相應地進行溝通。
利用多種渠道（如電子郵件、開發者門戶、API 回應）發送變更通知。

API 性能基準

為不同類型的 API 操作定義性能基準。
包括回應時間、吞吐量和錯誤率等指標。
根據系統改進和用戶期望定期審查和更新基準。

API 模擬和沙盒環境

為開發者提供 API 測試用的模擬或沙盒環境。
根據測試需求提供不同級別的沙盒環境（如無狀態、有狀態）。
確保沙盒環境盡可能模仿生產行為，同時保護敏感數據。

API 安全掃描

對所有 API 實施定期安全掃描。
根據 API 的重要性定義安全掃描頻率。
使用自動化工具進行持續安全監控，並輔以定期手動審核。

跨職能團隊協作

為 API 設計過程中不同團隊的協作制定指南。
使用協作工具，促進各利益相關者的參與。
明確定義 API 生命週期中每個參與團隊的角色和責任。