메인 콘텐츠로 건너뛰기
일반 작업용 Client 이 Client는 X API의 일반 엔드포인트와 상호 작용하기 위한 메서드를 제공합니다. 인증, 요청 포맷 구성, 응답 파싱을 처리하여 일반 관련 모든 작업을 처리합니다.

생성자

constructor

new GeneralClient(client): GeneralClient 새로운 GeneralClient 인스턴스를 생성합니다

매개변수

NameTypeDescription
clientClient주 X API Client 인스턴스

반환값

GeneralClient

정의된 위치

general/client.ts:42

메서드

getOpenApiSpec

getOpenApiSpec(options): Promise<Response> OpenAPI 명세를 가져옵니다. 전체 OpenAPI 명세를 JSON 형식으로 반환합니다. (참고: https://github.com/OAI/OpenAPI-Specification/blob/master/README.md)

매개변수

이름type
optionsObject
options.requestOptionsObject
options.requestOptions.rawtrue

반환값

Promise<Response> API 응답으로 resolve되는 Promise이며, requestOptions.rawtrue인 경우 원시 Response

정의된 위치

general/client.ts:83 getOpenApiSpec(): Promise<GetOpenApiSpecResponse>

반환값

Promise<GetOpenApiSpecResponse>

정의된 위치

general/client.ts:92