OpenAPI Specification

OpenAPI規範

OpenAPI規範是Linux Foundation協作項目OpenAPI計劃中的社區驅動的開放規範。

OpenAPI規範（OAS）定義了HTTP API的標準，編程語言 - 敏捷的接口描述。這使得人類和計算機都可以發現和理解服務的功能，而無需訪問源代碼，其他文檔或網絡流量檢查。當通過OpenAPI正確定義時，消費者可以以最少的實現邏輯來理解並與遠程服務進行交互。類似於接口描述為低級編程所做的，OpenAPI規範可以刪除調用服務時的猜測工作。

用於機器可讀的API定義文檔的用例包括但不限於：交互式文檔；用於文檔，客戶和服務器的代碼生成；和測試用例的自動化。 OpenAPI文檔描述了API服務，並以YAML或JSON格式表示。這些文檔可以在靜態上產生和提供，也可以從應用程序中動態生成。

OpenAPI規範不需要重寫現有的API。它不需要將任何軟件綁定到服務 - 所述服務甚至可能不由其描述的創建者擁有。但是，它確實要求在OpenAPI規範的結構中描述服務的功能。並非所有服務都可以通過OpenAPI描述 - 此規範並非旨在涵蓋HTTP API的所有可能樣式，而是包括對REST API的支持。 OpenAPI規範不要求特定的開發過程，例如設計優先或代碼優先。它確實通過與HTTP API建立明確的相互作用來促進兩種技術。

這個GitHub項目是OpenAPI的起點。在這裡，您可以找到有關OpenAPI規範所需的信息，簡單的示例以及有關該項目的一些一般信息。

版本

該存儲庫包含所有已發布的OpenAPI規範版本的降價來源。有關發行說明和發布候選版本，請參閱“版本”頁面。

該存儲庫中的每個文件夾，例如模式和測試，都應包含與規範的當前和先前版本有關的文件夾。

在行動中看到它

如果您只想看到它的工作，請查看當前示例的列表。

工具和庫

希望查看如何創建自己的OpenAPI定義，呈現或以其他方式使用它？查看日益增長的實施列表。

參與

當前開發OpenAPI規範的過程在貢獻指南中描述。

開發OpenAPI規範的下一個版本由技術指導委員會（TSC）指導。這組提交者帶來了他們的API專業知識，結合了社區的反饋，並適當擴展了一組承諾。未來規範的所有開發活動將作為功能進行並合併到該分支中。發布未來規範後，該分支將合併到main 。

TSC舉行每週的Web會議，以查看開放請求並討論與不斷發展的OpenAPI規範有關的開放問題。參與每週電話和預定的工作會議向社區開放。您可以在線查看整個OpenAPI技術會議日曆。

OpenAPI倡議鼓勵個人和公司的參與。如果您想參加OpenAPI規範的演變，請考慮採取以下措施：

• 查看規範的降價來源和權威性真相HTML渲染，包括完整的信用和引用。
• 查看貢獻過程，以便您了解規格如何發展。
• 檢查討論，問題並提取請求，以查看某人是否已經記錄了您的想法或有關規範的反饋。您可以通過訂閱現有問題或PR來關注現有的對話。
• 每天（或一周）在您的收件箱中訂閱通過CodetRiage.com訂閱一個公開問題。
• 進行討論來描述一個新的問題，理想情況下，對相關用例的明確解釋。

並非所有反饋都可以容納，並且可能存在紮實的論據，或者反對適合規範的更改。

許可

請參閱：許可證（Apache-2.0）