rest 호출 예제

cURL을 사용하려면 컬을 입력한 다음 요청하는 끝점을 입력합니다. 예를 들어 Github의 루트 끝점을 얻으려면 다음을 입력합니다: 이 항목에서 각 예제의 첫 번째 줄에는 동사(GET, POST 등)와 리소스 및 REST API 버전 번호를 설명하는 URI 부분이 표시됩니다. 예를 들어 URI 예제에 로그인하면 각 URL이 요청이라고, 다시 전송된 데이터를 응답이라고 합니다. 다음 예제에서는 사용자 목록을 받는 요청을 보여 주며, 이 에 대한 요청이 표시됩니다. 나머지 끝점은 모든 API 호출에 대한 공통 끝점입니다. API URL-나머지 끝점과 API 끝점이 함께 API URL을 구성하는 일부입니다. 이 문서에서는 cURL이라는 명령줄 유틸리티를 사용합니다. API 문서는 일반적으로 cURL을 참조하여 작성되기 때문에 cURL을 사용합니다. cURL을 사용하는 방법을 이해하면 API 설명서를 이해하는 데 아무런 문제가 없습니다. 그런 다음 원하는 언어로 요청을 쉽게 수행할 수 있습니다. 사용자와 같은 리소스 목록을 얻으려면 GET 요청을 보냅니다. 요청에는 로그인 호출에서 반환된 인증 토큰이 포함된 X-Tableau-Auth 헤더가 포함되어야 합니다.

요청 본문이 없습니다. 데이터 원본 또는 통합 문서와 같은 리소스를 게시하려면 두 가지 옵션이 있습니다. 단일 호출을 사용하여 리소스를 게시할 수 있습니다. 이 경우 다중 파트/혼합의 콘텐츠 형식을 사용하여 POST 요청을 만들고 요청 본문에 리소스를 포함합니다. REST는 API의 모양을 결정합니다. 그것은 “표현 상태 전송”을 의미합니다. 개발자가 API를 만들 때 따르는 규칙 집합입니다. 이러한 규칙 중 하나는 특정 URL에 연결할 때 리소스라고 하는 데이터 조각을 얻을 수 있어야 한다고 명시되어 있습니다. 예를 들어 HTTP는 동사(또는 “메서드”), URI, 인터넷 미디어 유형, 요청 및 응답 코드 등의 측면에서 매우 풍부한 어휘를 가지고 있습니다. REST는 HTTP 프로토콜의 이러한 기존 기능을 사용하므로 기존 계층화된 프록시 및 게이트웨이 구성 요소가 HTTP 캐싱 및 보안 적용과 같은 네트워크에서 추가 기능을 수행할 수 있습니다. 리소스 이름, 계층 구조 및 매개 변수, 지원되는 메서드, 페이로드 형식은 엄격하게 정의되지 않습니다. 기술적으로 HTTP 프로토콜과 일치해야 하지만 사용할 실제 형식은 사용자 입니다.

예를 들어 일부 서버는 업데이트 요청에 PUT 메서드를 사용하고 다른 서버는 PATCH 또는 UPDATE를 사용합니다. 일부 API는 페이로드에 JSON 형식을 사용하고 다른 API는 XML을 사용하거나 둘 다 지원합니다. API 소비자에게 사용 가능한 리소스, 메서드, 매개 변수 및 데이터 형식에 대한 정보를 제공하려면 API 사양을 만들 수 있습니다. REST API는 제공 할 수있는 것과 그것을 사용하는 방법, 쿼리 매개 변수, 응답 형식, 요청 제한, 공개 사용 / API 키, 방법 (GET / POST / PUT / DELETE), 언어 지원, 콜백 사용, HTTPS 지원 및 리소스와 같은 세부 사항을 지정해야합니다. 표현은 자기 설명이어야합니다 … 리소스로 수행할 작업은 요청 시작 줄에서 대문자로 작성된 메서드(동사)에 의해 설정됩니다. 예를 들어, 다음 요청 시작 줄 – POST, PUT, PATCH 및 DELETE 요청이 데이터베이스를 변경하기 때문에 개발자는 거의 항상 인증 벽 뒤에 배치합니다. 경우에 따라 GET 요청에는 인증이 필요합니다(예: 현재 잔액을 확인하기 위해 은행 계좌에 액세스할 때). 이 메서드는 서버에 요청을 보낼 때 사용되는 6개의 매개 변수로 구성됩니다. 필요한 API 호출에 따라 이러한 매개 변수는 다를 수 있습니다. HTTP 헤더는 콜론으로 구분되는 속성 값 쌍입니다.

아래 예제에서는 서버에 JSON 콘텐츠를 예상하도록 지시하는 헤더를 보여 줍니다. 요청에 추가할 사용자 지정 헤더 목록을 표시합니다. 도구 모음 항목을 사용하여 새 사용자 지정 헤더를 추가하거나 기존 헤더를 삭제합니다. 예를 들어 탭의 다음 항목 – 스프링 기반 RESTful 웹 서비스를 사용하는 jQuery 클라이언트를 빌드합니다. 특히 클라이언트는 CORS를 사용한 RESTful 웹 서비스 빌드에서 만든 서비스를 사용합니다.