REST API 스키마 정의

스키마를 정의하여 REST API 내에서 요청 또는 응답에 대한 예상 데이터 구조를 지정합니다.

시작하기 전에

필요한 역할: web_service_admin

이 태스크 정보

스키마는 OpenAPI 3.0.1 형식의 REST API에 대한 요청 및 응답 본문과 헤더의 구조와 형식을 정의하는 기록입니다. 에서 스키마 ServiceNow AI Platform를 정의하면 스키마는 연결된 REST API 내에서 요청 및 응답의 구조를 정의하는 데 사용됩니다. 그런 다음 요청 및 응답에 대한 스키마 데이터를 API의 익스포트 가능한 OpenAPI 사양에서 사용할 수 있습니다. OpenAPI 사양 익스포트에 대한 자세한 내용은 다음 문서를 참조하십시오 OpenAPI 사양으로 익스포트.

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

프로시저

1. 다음 방법 중 하나로 REST 스키마를 생성합니다.

   옵션	절차
   스크립팅된 REST API 기록을 통해 탐색	다음으로 이동 모두 > 시스템 웹 서비스 > 스크립트 기반 REST API. 스크립팅된 REST API 기록을 선택합니다. 스키마 관련 목록에서 새로 만들기를 선택합니다.
   새 REST 스키마 기록으로 직접 이동	다음으로 이동 모두 > 필터 을 입력하고 sys_ws_schema.form을 입력합니다. API 필드에서 스키마와 연결할 API를 선택하거나 입력합니다.

2. 이름 필드에 스키마의 이름을 입력합니다.
3. 다음에서 스키마 필드에서 OpenAPI 버전 3.0.1 형식을 사용하여 새 스키마의 데이터 유형과 구조를 정의합니다.
   예를 들어 다음 항목은 스키마가 이름이 포함된 객체임을 지정합니다. 첫 번째 이름은 문자열 데이터 형식입니다.

   { "type": "object", "properties": { "firstName": { "type": "string" } } }

4. OpenAPI 버전을 선택합니다.
5. 설명 필드에서 새 스키마의 예상 구조를 요약합니다.
6. 제출을 선택합니다.

다음에 수행할 작업

필요에 따라 추가 스키마를 정의합니다. 스키마를 사용하여 REST 요청 또는 응답에 예상되는 구조와 형식을 지정합니다. 자세한 내용은 API 자원 요청 구조 정의 또는 API 자원 응답 구조 정의 문서를 참조하십시오.