Skip to main content
X API v2는 모든 endpoint에서 일관된 패턴으로 설계되었습니다. 한 endpoint의 동작 방식을 학습하면 동일한 패턴이 다른 모든 곳에 적용됩니다.

일관된 패턴

URL 구조

모든 v2 endpoint는 예측 가능한 패턴을 따릅니다:
예시:

응답 구조

모든 응답은 동일한 최상위 구조를 사용합니다:

ID 형식

언어 호환성을 보장하기 위해 모든 ID는 문자열로 반환됩니다:

Field 및 expansion

동일한 fieldsexpansions 파라미터가 일관되게 동작합니다:

객체 스키마

동일한 객체 유형은 어떤 endpoint가 반환하든 동일한 field를 갖습니다:
  • 검색으로 얻은 Post는 조회로 얻은 Post와 동일한 field를 갖습니다
  • 팔로워로 얻은 User는 검색으로 얻은 User와 동일한 field를 갖습니다
  • 확장된(expanded) 객체는 독립형 객체와 일치합니다

인증

모든 endpoint는 동일한 인증 방법을 사용합니다:

오류 처리

오류는 일관된 형식을 따릅니다:
모든 오류 유형 보기 →

페이지네이션

모든 페이지네이션 endpoint는 동일한 토큰 시스템을 사용합니다: 페이지네이션에 대해 자세히 알아보기 →

명명 규칙

  • 미국식 영어 철자(favorites가 아닌 favourites 아님)
  • field 이름에 snake_case 사용(author_id, created_at)
  • 일관된 용어(field에서 repost_count가 아닌 retweet_count)

빈 값

값이 없는 field는 null로 반환되지 않고 생략됩니다:

Entity 일관성

entities 객체에는 텍스트에서 파싱된 엔티티만 포함됩니다:
  • urls
  • hashtags
  • mentions
  • cashtags
미디어 및 투표는 entities가 아닌 attachments에 있습니다.

이것이 의미하는 것

한 번 배우면 어디서든 사용

한 endpoint에서 배운 패턴이 모든 endpoint에 적용됩니다.

예측 가능한 응답

동일한 객체 유형은 API 전체에서 동일한 구조를 가집니다.

더 간단한 코드

일반적인 패턴에 대한 재사용 가능한 함수를 구축합니다.

쉬운 디버깅

일관된 오류 형식이 문제 해결을 단순화합니다.

불일치 신고

불일치를 발견하셨나요? 알려주세요: