discord api spec

Discord OpenAPI 사양

이 저장소에는 Discord API에 대한 OpenAPI 3.1 사양의 공개 미리보기가 포함되어 있습니다. 현재 이 사양은 최신 Discord API 버전(v10)에서만 사용할 수 있습니다.

️ OpenAPI 사양의 공개 미리 보기는 사전 통지 없이 크게 변경될 수 있으며 프로덕션 환경 내에서는 사용해서는 안 됩니다.

용법

사양 파일

사양에는 표준 사양과 미리 보기 사양의 두 가지 버전이 포함되어 있습니다.

• openapi.json 은 안정적인 공개 API를 포함하는 표준 사양입니다.
• openapi_preview.json 은 불안정하거나 실험적인 API 기능을 포함하는 미리보기 사양입니다. 이는 안정적인 것으로 간주되거나 프로덕션 환경에서 사용되어서는 안 됩니다 .

Postman과 통합

Postman과 함께 사양을 사용하려면 공개 컬렉션을 볼 수 있습니다.

기여

OpenAPI 사양 콘텐츠는 자동으로 생성되므로 이 저장소에 대한 공개 기여를 허용하지 않습니다 .

? 버그 수정이나 개선을 위해 문제를 열 ​​수 있습니다.

사양 규칙

• 이는 미리보기이므로 정확하지 않을 수 있습니다. 아래에 언급된 것 외에 사양과 문서 사이에 불일치가 발견되면 알려주시고 사양이 아닌 문서를 따르세요.
• anyOf 및 oneOf 공용체를 정의하더라도 이는 모두 목록에서 한 가지 유형만 데이터 형식으로 사용할 수 있음을 의미합니다. 예를 들어 anyOf: {'Cat', 'Dog'} 여전히 Cat+Dog Dog가 아닌 Cat 또는 Dog 전달할 수 있음을 의미합니다. 이는 사용자 정의 확장 x-discord-union: oneOf 로 표시됩니다. 기술적으로 oneOf 사용할 수 없을 때 anyOf 사용합니다. 그렇게 하는 이유 중 하나는 모든 필드가 선택 사항이고 전달된 데이터가 둘 이상의 형식으로 유효성을 검사할 수 있는 경우입니다.
• 응답 필드를 과도하게 지정하는 것을 피하고 int32 와 같은 필드 유형만 정의하며 특정 최소값, 최대값 등을 정의하지 않습니다.
• 문서에서 문자열로 입력된 일부 필드는 사양에서 int로 입력될 수 있습니다. 우리 API는 int로 구문 분석할 수 있는 경우 int 필드에 대한 문자열을 허용합니다. 우리는 int로 구문 분석 가능한 문자열을 int로 지정하는 것이 더 정확할 것이라고 생각합니다.

알려진 문제

• (거의) 모든 null 허용 필드는 추가로 선택 사항으로 표시되고 모든 선택 필드는 추가로 null 허용으로 표시됩니다.
• 작업 및 필드에는 설명이 없습니다.
• 작업에는 태그가 없습니다.
• 플래그 필드는 특정 플래그 값과 그 의미를 자세히 설명하지 않습니다.
• 선택적 쿼리 인수는 별 의미가 없더라도 null 허용으로 입력됩니다.