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 会更精确。

已知问题

• （几乎）所有可为空的字段都额外标记为可选，并且所有可选字段都额外标记为可为空。
• 操作和字段没有描述。
• 操作没有标签。
• 标志字段不详细说明特定的标志值及其含义。
• 可选查询参数被键入为可为空，即使它没有多大意义。