常見問題

一般問題

如果我違反了一些ADP指導原則會怎樣?

你不會受到懲罰。ADP 的角色是幫助者而非律師。然而，建議遵循這些指導原則以確保整個組織的一致性和最佳實踐。

ADP多久更新一次?

ADP 會定期審查並根據需要進行更新。更新頻率可能因特定ADP以及行業標準或組織需求的變化而有所不同。

我可以提議一個新的ADP嗎?

可以，你可以提議一個新的ADP。請遵循ADP-2: ADP 撰寫中概述的指導原則來提交新的ADP提案。

ADP撰寫和結構

撰寫ADP時應使用什麼語言?

ADP 應使用美式英語撰寫，以保持整個文件的一致性。但如果資源允許，可能會提供繁體中文翻譯。

我應該如何格式化我的ADP?

ADP 應以Markdown格式撰寫。詳細的格式指南請參考ADP-2。

ADP如何分類?

ADP 被分類到預定義的類別中，如"ADP本身"、"工程原則"、"HTTP基礎"等。完整的類別列表請參見ADP-2。

ADP編號如何分配?

ADP 編號根據不同類型API的特定範圍進行分配。有關ADP編號的詳細資訊，請參考ADP-3。

API設計和實現

我需要在ADP中包含OpenAPI示例嗎?

是的，如果你的ADP與HTTP API設計相關，你應該按照ADP-2的要求包含OpenAPI文件示例。

如果我的特定API需要偏離ADP指導原則怎麼辦?

如果你需要偏離指導原則，你可以按照ADP-46中的概述指定例外情況。確保記錄偏離的原因和任何潛在影響。

如何註冊新的API相關術語或概念?

按照ADP-49中描述的 API 術語註冊流程來註冊新的問題類型、自定義偏好、應用程序ID、自定義標頭、鏈接關係或授權方案。

版本控制和變更

ADP中如何處理變化?

ADP 遵循ADP-2中概述的生命週期。若 ADP 本身發生重大變化導致無法適用，需要將其棄用。

如果我發現錯誤或對現有ADP有建議，我該怎麼辦?

如果你發現錯誤或有建議，你可以通過 ADP 網站的存儲庫提交反饋或提出更改。按照ADP-2中提到的指導原則提交 pull request。

合規和治理

誰負責監督ADP流程?

暫定為網站的設計者，請見 ADP-1。

ADP的例外情況多久審查一次?

應定期審查例外情況，以確保它們仍然必要且不會對整體API生態系統產生負面影響。確切頻率可能會有所不同，但最好至少每年審查一次。

DRAFT 在哪裡可以找到所有註冊的API術語和概念的內部頁面?

組織維護著所有註冊術語、問題類型、偏好和應用程序ID的內部站點。請聯繫ADP設計者(參照 ADP-1)以獲取此存儲庫/頁面的訪問權限。

目前這個內部站點還在規劃中。