APIGit
2023-07-20
當您選擇編輯規範文件時,您會發現幾個不同的視圖。其中之一稱為治理。在此視圖中,您將看到審核結果,並能夠根據您設置的規則為每個警告或錯誤提供評論。
以下是 API 最佳實踐的要點:
信息: 確保每個 API 都具有標題、描述和其他必要信息等基本屬性。
版本控制: 對每個 API 強制使用標準語義或基於日期的版本控制。
操作: 確保每個單獨的操作都包含摘要、描述和 ID。
參數: 標準化參數名稱的格式並確保所有參數都有適當的描述。
回應: 倡導跨 API 使用一組通用的狀態代碼、媒體類型和架構響應。
架構: 使用 JSON 架構組件標準化所有請求和響應架構。
目前,我們有一個基本規則,名為OpenAPI Best Practice
。將來,我們計劃引入更多規則集,包括 OWASP Top 10 Security 和自定義規則集。請繼續關注這些即將推出的新增內容。
API 治理不僅僅包括設計和標準;它圍繞著賦予人們權力並最大化 API 的價值。通過利用自動化、研討會和培訓課程,API 治理可幫助用戶制定安全措施、產品定義和實施策略。為了確保其有效性,了解 API 治理的所有組成部分和影響至關重要。如需進一步指導,請繼續關注 Apigit 博客,了解有關重要 API 治理主題的即將發布的帖子。