OpenAPI 단계

  • 릴리스 버전: Washingtondc
  • 업데이트 날짜 2024년 02월 01일
  • 읽기5분

    • 외부 공급업체 아웃바운드 REST 웹 서비스의 OpenAPI 사양을 임포트하고 웹 서비스에 대한 통합을 빌드합니다. 기본 REST API 작업에 대한 요청 세부 정보는 OpenAPI 사양에서 파생됩니다.

    JSON 출력 응답 본문의 경우, 시스템은 OpenAPI 사양에서 복합 데이터 객체 출력을 생성합니다.

    주:
    OpenAPI 단계 은 기본 시스템에서 사용할 수 없으며 구독이 ServiceNow® Integration Hub 필요합니다. 필요한 플러그인이 활성화되면 통합 아래에서 단계를 볼 수 있습니다.

    역할 및 가용성

    작업 디자이너 작업 단계로 사용할 수 있습니다. action_designer 및 open_api_admin 또는 관리자 역할을 가진 사용자는 하나 이상의 작업 단계로 사용자 지정 작업을 만들 수 있습니다.

    필드

    필드 설명
    연결 별칭 시스템에서 작업 단계를 실행하는 데 사용하는 연결 및 자격 증명 별칭 기록입니다. action_designer 및 connection_admin 또는 관리자 역할을 가진 사용자는 연결된 연결 별칭 기록을 선택할 수 있습니다. 별칭을 사용하면 여러 환경에서 작업을 사용할 때 여러 자격 증명과 연결 정보 프로필을 구성하지 않아도 됩니다. 마찬가지로 연결 정보가 변경되면 사용자 지정 동작을 업데이트할 필요가 없습니다. 연결 및 자격 증명에 대한 자세한 내용은 자격 증명, 연결 및 별칭을 참조하십시오.
    기본 URL REST 요청에 대한 연결 별칭의 기본 URL입니다.
    API 소스

    요청을 구성하는 데 사용되는 OpenAPI v2.0 및 v3.0 사양을 선택하거나 OpenAPI 가져오기 를 선택하여 새 OpenAPI 사양을 가져오는 옵션입니다. YAML 또는 JSON에 URL과 자격 증명을 제공하거나 컨텐츠를 복사하여 붙여넣어 사양을 임포트할 수 있습니다.
    API 작업

    목록에서 작업을 선택하는 옵션입니다. 사용 가능한 조작은 API 소스 필드의 OpenAPI 사양에 의해 제공됩니다.
    리소스 경로 자원의 경로입니다.
    HTTP 메서드 요청을 처리하는 데 사용되는 HTTP 메서드입니다.
    • 가져오기
    • POST
    • PUT
    • 패치
    • DELETE
    쿼리 매개 변수

    REST 엔드포인트에 전달할 이름-값 쌍입니다. 이러한 매개변수를 수동으로 생성하거나 입력 변수를 매개변수 필드로 끌어온 다음 값을 할당할 수 있습니다.

    중복된 쿼리 매개변수 이름이 포함된 REST 단계 요청을 지원합니다. 중복된 쿼리 매개변수 이름이 포함된 REST 요청을 생성하는 경우 은 플로우 디자이너 정의한 순서와 동일한 순서로 쿼리 매개변수를 요청에 추가합니다.

    주:
    OpenAPI 사양을 임포트할 때, 시스템은 사양에 있는 모든 매개변수와 헤더를 REST 단계에 추가합니다. 마지막 REST 단계 값을 검토하고 요청에서 보내지 않으려는 매개변수를 제거합니다. 예를 들어, API가 JSON과 XML에 대한 컨텐츠 유형 헤더를 허용하는 경우 시스템은 두 헤더를 모두 REST 단계에 추가합니다. 응답에서 수신하려는 컨텐츠 유형에 따라 헤더 중 하나를 제거하십시오.
    머리글

    요청과 함께 보낼 헤더입니다. 헤더를 수동으로 생성하거나 입력 변수를 매개변수 필드로 끌어온 다음 값을 할당할 수 있습니다.

    중복 요청 헤더가 포함된 REST 단계 요청을 지원합니다. 중복 요청 헤더가 포함된 REST 요청을 생성하면 헤더는 정의한 순서와 동일한 순서로 전송됩니다.

    주:
    OpenAPI 사양을 임포트할 때, 시스템은 사양에 있는 모든 매개변수와 헤더를 REST 단계에 추가합니다. 마지막 REST 단계 값을 검토하고 요청에서 보내지 않으려는 매개변수를 제거합니다. 예를 들어, API가 JSON과 XML에 대한 컨텐츠 유형 헤더를 허용하는 경우 시스템은 두 헤더를 모두 REST 단계에 추가합니다. 응답에서 수신하려는 컨텐츠 유형에 따라 헤더 중 하나를 제거하십시오.
    첨부 파일 요청이 포함된 첨부 파일 기록입니다. 이전 단계에서 이 기록을 조회 또는 작성하고 입력 변수로 정의할 수 있습니다. 스크립트 단계에서 JSONStreamingBuilder 및 XMLStreamingBuilder API를 사용하여 이를 작성하십시오.
    주:
    이 필드는 요청 유형 목록에서 이진수를 선택할 때 사용할 수 있습니다.
    재시도 정책 사용 재시도 정책을 활성화하는 옵션입니다. 자세한 내용은 재시도 정책을 참조하십시오.
    별칭에 대한 기본 정책 무효화 기본 재시도 정책을 무효화하는 옵션입니다. 연결 목록에서 연결 인라인 정의를 선택한 경우에는 이 확인란을 적용할 수 없습니다.
    재시도 정책 연결 별칭에 연결된 기본 재시도 정책입니다. 별칭에 대한 기본 정책 무효화를 선택한 경우 기본 재시도 정책을 무효화하고 필요에 따라 다른 기존 재시도 정책을 선택할 수 있습니다.

    작업 오류 평가 필드

    필드 설명
    이 단계가 실패할 경우 다음 단계를 계속 실행하거나 오류 평가로 이동하는 옵션입니다. 사용자 지정 작업 오류 조건에 대한 단계 상태 코드 또는 메시지를 사용하려면 을 참조하십시오 Action error evaluation.
    Open API 단계의 필드

    작업 오류 평가 필드

    필드 설명
    이 단계가 실패할 경우 다음 단계를 계속 실행하거나 오류 평가로 이동하는 옵션입니다. 사용자 지정 작업 오류 조건에 대한 단계 상태 코드 또는 메시지를 사용하려면 을 참조하십시오 Action error evaluation.

    알려진 제한사항

    이러한 제한사항을 사용하여 OpenAPI 사양에서 OpenAPI 단계를 생성합니다.

    요청 본문 미디어 유형
    요청 본문은 JSON 미디어 유형만 지원합니다.
    주:
    문자열 형식 출력 개체는 OpenAPI 스키마에 additionalProperties가 있거나 속성이 없는 경우에 만들어집니다.
    OpenAPI 3.0 구성요소

    OpenAPI 3.0은 API를 더 자세히 설명하기 위해 Swagger 2.0에 새 구성요소를 추가합니다. OpenAPI 단계의 OpenAPI 지원은 이러한 구성요소 전부는 아니지만 일부만 지원합니다. OpenAPI 단계는 현재 이러한 구성 요소를 지원하지 않습니다.

    • 스키마 객체: additionalProperties 속성
    • 판별자 객체
    • 정보 객체: termsOfService, 연락처, 라이센스 필드
    • 예제 객체
    • 링크 객체
    • 콜백 객체
    • 보안 체계 객체
    • 보안 요구 사항 객체
    • 태그 객체
    • 외부 문서 객체
    • 서버 개체
    • 사양 확장
    • 재귀 참조

    이러한 구성 요소에 대한 자세한 내용은 OpenAPI 설명서에서 확인할 수 있습니다. OpenAPI 사양을 참조하세요.

    지원되는 최대 작업 수
    API 작업 수는 기본적으로 500개로 제한됩니다. 그러나 시스템 속성을 glide.rest.openapi.max_operation_limit사용하여 1에서 1,000까지의 작업 수를 구성할 수 있습니다.