API 자원 요청 구조 정의

REST 요청 기록에 스키마를 추가하여 요청의 예상 데이터 구조를 정의합니다.

시작하기 전에

요청 구조를 정의하기 전에 REST API에서 하나 이상의 REST API 자원과 하나 이상의 스키마를 정의해야 합니다.

필요한 역할: web_service_admin

이 태스크 정보

다음 절차에서는 요청 스키마를 자원에 수동으로 추가하는 프로세스를 설명합니다. 비프로덕션 인스턴스에서 요청 스키마 정의를 자동으로 생성하는 방법에 대한 자세한 내용은 다음 문서를 참조하십시오 API 요청 정의 자동 생성.

프로시저

1. 다음 방법 중 하나를 사용해 새 REST 요청 기록으로 이동합니다.
   스크립팅된 REST API 기록을 탐색하는 경우 REST 요청 기록의 필드는 대부분 미리 채워집니다.

   옵션	절차
   스크립팅된 REST API 기록을 통해 탐색	다음으로 이동 모두 > 시스템 웹 서비스 > 스크립트 기반 REST API. 스크립팅된 REST API 기록을 선택합니다. 자원 관련 목록에서 자원을 선택합니다. 요청 스키마 탭에서 새로 만들기를 선택합니다.
   새 REST 요청 기록으로 직접 이동	다음으로 이동 모두 > 필터 을 입력하고 sys_ws_request_spec.form을 입력합니다. API 필드에서 API를 선택합니다. API 자원 필드에서 요청 스키마를 지정할 API 자원을 선택합니다. 버전 필드에서 API 자원 버전을 선택합니다. Http 메서드 필드에서 요청 스키마를 지정하려는 메서드(예: PUT)를 선택합니다.

2. 스키마 필드에서 자원 요청 본문의 구조와 형식을 정의할 스키마를 찾거나 입력합니다.
3. 설명 필드에 REST 요청의 예상 형식을 요약합니다.
4. 제출을 선택합니다.

결과

요청 본문 구조를 정의하는 데 사용한 스키마는 REST API 탐색기의 익스포트 가능한 OpenAPI 사양에 포함되어 있습니다. OpenAPI 사양 익스포트에 대한 자세한 내용은 다음 문서를 참조하십시오 OpenAPI 사양으로 익스포트.