API 자원 응답 구조 정의

  • 릴리스 버전: Australia
  • 업데이트 날짜 2026년 03월 12일
  • 소요 시간: 1분

    • REST 응답에 스키마 및 관련 응답 헤더를 추가하여 응답의 예상 데이터 구조를 정의합니다.

    시작하기 전에

    관련 REST API에서 사용하려면 하나 이상의 REST API 자원과 하나 이상의 스키마를 미리 정의해야 합니다. 또한 사용하려는 응답 헤더를 정의해야 합니다. 자세한 내용은 REST API 응답 헤더 정의 문서를 참조하십시오.

    필요한 역할: web_service_admin

    프로시저

    1. 다음 방법 중 하나를 사용해 새 REST 응답 기록으로 이동합니다.
      스크립팅된 REST API 기록을 탐색할 때 REST 응답 기록의 필드 대부분은 미리 채워집니다.
      옵션절차
      스크립팅된 REST API 기록을 통해 탐색
      1. 다음으로 이동 모두 > 시스템 웹 서비스 > 스크립트 기반 REST API.
      2. 스크립팅된 REST API 기록을 선택합니다.
      3. 자원 관련 목록에서 자원을 선택합니다.
      4. 응답 스키마 탭에서 새로 만들기를 선택합니다.
      REST 응답 기록으로 직접 이동
      1. 다음으로 이동 모두 > 필터 을 입력하고 sys_ws_response_spec.form을 입력합니다.
      2. API 필드에서 API를 선택합니다.
      3. API 자원 필드에서 응답 형식을 지정할 API 자원을 선택합니다.
      4. HTTP 메서드 필드에서 응답 형식을 지정하려는 메서드(예: GET)를 선택합니다.
      5. 버전 필드에서 API 자원 버전을 선택합니다.
    2. HTTP 상태 필드에 REST 응답 사양이 적용되는 HTTP 상태(예: 200)를 입력합니다.
      예를 들어 200을 입력하여 ABC 상태를 반환합니다.
    3. 스키마 필드에서 자원에서 선택한 HTTP 상태, 버전 및 메서드의 구조와 형식을 정의하는 스키마를 찾거나 입력합니다.
    4. 옵션: API와 연결된 관련 응답 헤더를 추가합니다.
      1. 응답 헤더 잠금 해제 아이콘을 선택합니다.
      2. API와 연결된 관련 응답 헤더를 찾거나 입력합니다.
    5. 설명 필드에 REST 응답의 예상 형식을 요약합니다.
    6. 제출을 선택합니다.

    결과

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