discord api spec

Discord OpenAPI 規範

此儲存庫包含 Discord API 的 OpenAPI 3.1 規範的公共預覽版。目前，該規範僅適用於最新的 Discord API 版本 (v10)。

️ OpenAPI 規範的公開預覽版如有重大更改，恕不另行通知，且不應在生產環境中使用。

用法

規格文件

包含兩個版本的規格 - 標準規格和預覽規範：

• openapi.json是包含穩定的公共 API 的標準規格。
• openapi_preview.json是預覽規範，其中包含不穩定和/或實驗性 API 功能。這不應被視為穩定或在生產環境中使用。

與郵差集成

要將規範與 Postman 一起使用，您可以查看公共集合。

貢獻

OpenAPI 規範內容是自動產生的，因此我們不允許對此儲存庫進行公開貢獻。

？對於錯誤修復或改進，您可以提出問題。

規格約定

• 這是預覽，可能不正確。如果您發現規範與我們的文件之間存在差異（除了下面提到的差異），請告訴我們，並遵循文件而不是規範。
• 即使我們定義了anyOf和oneOf聯合，它們都意味著清單中只有一種類型可以用作資料格式。例如， anyOf: {'Cat', 'Dog'}仍然意味著您可以傳遞Cat或Dog ，而不是Cat+Dog 。這由自訂擴充功能x-discord-union: oneOf表示。當我們在技術上無法使用oneOf時，我們使用anyOf 。這樣做的原因之一是，例如，當所有欄位都是可選的且傳入的資料可以使用多種格式進行驗證時。
• 我們避免過度指定回應字段，而僅定義字段類型，例如int32 ，並且避免定義特定的最小值、最大值等。
• 在我們的文件中鍵入為字串的某些欄位可能在規格中鍵入為整數。如果 int 欄位可解析為 int，我們的 API 接受字串。我們認為將這些可解析 int 的字串指定為 int 會更精確。

已知問題

• （幾乎）所有可為空的欄位都額外標記為可選，並且所有可選欄位都額外標記為可為空。
• 操作和字段沒有描述。
• 操作沒有標籤。
• 標誌欄位不詳細說明特定的標誌值及其意義。
• 可選查詢參數被鍵入為可為空，即使它沒有太大意義。