오퍼레이션에 대한 매개변수 정의

온라인에서 편집하기

오퍼레이션 매개변수는 해당 특정 오퍼레이션과 연관된 URL 경로의 경우, URL 경로, 조회 매개변수, 헤더 또는 본문 매개변수의 변수 요소를 정의할 수 있습니다.

이 태스크에 대한 정보

참고:
  • 이 태스크는 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 소스 파일로 바로 전환할 수 있습니다. 양식 화면으로 돌아가려면 양식 아이콘을 클릭하세요 양식 아이콘.

프로시저

  1. OpenAPI 3.0 API 정의 편집에 설명된 대로 편집할 API를 여십시오.
  2. 경로를 펼친 후 필요한 경로를 펼치십시오.
  3. 조작을 펼친 후 필요한 조작을 펼치십시오.
  4. 새 오퍼레이션 매개변수를 작성하거나, 기존 매개변수를 편집할 수 있습니다.
    • 작업 매개변수를 생성하려면 ‘매개변수’ 옆의 추가 OpenAPI 3.0 API 추가 아이콘 아이콘을 클릭한 다음, ‘매개변수 생성’ 섹션을 참조하십시오.
    • 기존 작업 매개변수를 편집하려면 탐색 창에서 매개변수 이름을 클릭한 다음, ‘매개변수 편집’ 섹션을 참조하십시오.