헤더 컴포넌트 정의

온라인에서 편집하기

헤더 구성요소는 API 요청에서 보내거나 API 응답에서 리턴될 수 있는 재사용 가능한 사용자 정의 헤더를 정의합니다.

이 태스크에 대한 정보

참고:
  • 이 태스크는 OpenAPI 3.0 API 정의 구성과 관련이 있습니다. OpenAPI 2.0 API 정의를 구성하는 방법에 대한 세부사항은 OpenAPI 2.0 API 정의 편집을 참조하십시오.
  • OpenAPI 3.0 API는 DataPower Gateway (v5 compatible)가 아닌 DataPower® API Gateway에서만 지원됩니다.
  • 현재 OpenAPI 3.0 지원 제한사항에 대한 세부사항은 IBM® API Connect 의 OpenAPI 3.0 지원의 내용을 참조하십시오.

API Designer UI 애플리케이션을 사용하거나 브라우저 기반 API Manager UI를 사용하여 이 태스크를 완료할 수 있습니다.

헤더 컴포넌트를 사용하려면 API 정의의 다른 곳으로부터 참조해야 합니다.

헤더는 매개변수와 유사하며 차이점은 다음과 같습니다.
  • 매개변수는 실제 데이터를 전달하고 일반 사용자에 사용 가능하며, 헤더는 요청 또는 응답과 연관된 메타 데이터를 전달하고 일반 사용자로부터 숨겨져 있습니다.
  • 매개변수의 위치는 다양할 수 있지만 헤더의 위치는 항상 header로 설정되어 있습니다.
  • 매개변수는 형식 스타일이 다양할 수 있지만 헤더의 스타일은 항상 simple입니다.
매개변수에 대한 자세한 정보는 매개변수 작성을 참조하십시오.

언제든지 소스 아이콘을 클릭하면 기본 OpenAPI 소스 아이콘OpenAPI YAML 소스 파일로 바로 전환할 수 있습니다. 양식 화면으로 돌아가려면 양식 아이콘을 클릭하세요 양식 아이콘.

프로시저

  1. OpenAPI 3.0 API 정의 편집에 설명된 대로 편집할 API를 여십시오.
  2. 구성요소 를 펼친 후 이미 하나 이상의 헤더 구성요소가 정의되어 있는 경우 헤더를 펼치십시오.
  3. 새 헤더 컴포넌트를 작성하거나, 기존 헤더 컴포넌트를 편집할 수 있습니다.
    • 헤더 컴포넌트를 만들려면 ‘헤더’ 옆의 추가 OpenAPI 3.0 API 추가 아이콘 아이콘을 클릭한 다음, ‘헤더 만들기 ’를 참조하세요.
    • 기존 헤더 구성 요소를 편집하려면 탐색 창에서 해당 헤더 구성 요소 이름을 클릭한 다음, ‘헤더 편집’ 섹션을 참조하십시오.