헤더 작성

온라인에서 편집하기

헤더는 API 요청에서 보내거나 API 응답에서 리턴될 수 있는 정보를 정의합니다. 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를 사용하여 이 태스크를 완료할 수 있습니다.

헤더는 매개변수와 유사하며 차이점은 다음과 같습니다.

매개변수는 실제 데이터를 전달하고 일반 사용자에 사용 가능하며, 헤더는 요청 또는 응답과 연관된 메타 데이터를 전달하고 일반 사용자로부터 숨겨져 있습니다.
매개변수의 위치는 다양할 수 있지만 헤더의 위치는 항상 header로 설정되어 있습니다.
매개변수는 형식 스타일이 다양할 수 있지만 헤더의 스타일은 항상 simple입니다.

매개변수에 대한 자세한 정보는 매개변수 작성을 참조하십시오.

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

프로시저

헤더를 작성하십시오. 처음부터 헤더를 작성하거나 헤더 컴포넌트에서 정의된 헤더를 참조할 수 있습니다.
- 처음부터 헤더를 작성하려면 정의 탭에 다음 정보를 제공하십시오.
  - 헤더 이름: 헤더 컴포넌트를 작성 중인 경우, 이 이름은 이 헤더가 API 정의의 다른 곳으로부터 참조할 수 있게 하는 키를 정의합니다. 참조의 형식은 다음과 같습니다.
```
#/components/headers/Name
```
  - 설명: 헤더에 대한 설명입니다. 서식 있는 텍스트를 표현하려면 CommonMark 구문을 사용할 수 있습니다.
  - 필수: 이 헤더가 필수인지 여부를 판별합니다.
  - 더 이상 사용되지 않음: 이 헤더가 더 이상 사용되지 않으며 사용법에서 전이되도록 지정합니다.
  - 비어 있는 값 허용: 헤더가 비어 있는 값으로 전송할 수 있습니다.
  - 확대: 선택한 경우, 유형 array 또는 object의 특성 값은 맵의 어레이 또는 키 값 쌍의 각 값을 위한 별도의 특성을 생성합니다.
  - 'Allow Reserved ': 헤더 값에 RFC3986 (:/?#[]@!$&'()*+,;=)에 정의된 예약된 문자를 퍼센트 인코딩 없이 포함할 수 있도록 허용할지 여부를 결정합니다.
- 헤더 컴포넌트에서 정의된 헤더를 참조하려면 참조 탭에 다음 정보를 제공하십시오.
  - 헤더 이름: 헤더 컴포넌트를 작성 중인 경우, 이 이름은 이 헤더가 API 정의의 다른 곳으로부터 참조할 수 있게 하는 키를 정의합니다. 참조의 형식은 다음과 같습니다.
```
#/components/headers/Name
```
  - 다음에서 참조: 헤더 컴포넌트에 대한 참조를 선택하십시오.
작성을 클릭하십시오.
헤더 세부 정보가 표시되어 추가 편집이 가능합니다. ‘헤더 편집’을 참조하십시오.