경로는 호출 가능한 REST API 단위입니다. 경로는 HTTP verb와 URL 경로를 포함합니다. 경로를 구성하여 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를 사용하여 이 태스크를 완료할 수 있습니다.
경로는 전체 URL을 형성하기 위해 서버 URL에 추가됩니다. 서버 구성에 대한 세부사항은 API에 대한 서버 정의를 참조하십시오.
언제든지 소스 아이콘 
을 클릭하여 기본 OpenAPI YAML 소스로 직접 전환할 수 있습니다. 디자인 양식으로 돌아가려면 양식 아이콘 
을 클릭하십시오.
프로시저
- OpenAPI 3.0 API 정의 편집에 설명된 대로 편집할 API를 여십시오.
- 이미 하나 이상의 경로가 정의되어 있는 경우 경로를 펼치십시오.
- 새 경로를 작성하려면 탐색 분할창에서 경로 옆에 있는 추가 아이콘
을 클릭하십시오. 기존 경로를 편집하려면 탐색 분할창에서 경로를 클릭하십시오.
- 다음 정보를 제공하십시오.
- 경로: 개별 엔드포인트에 대한 상대 경로입니다.
API에 액세스하기 위한 전체 URI를 구성하도록 경로가 기본 경로에 추가됩니다. 경로는/문자로 시작해야 하지만 끝나서는 안됩니다. 경로 끝에 있는 매개변수는 하나 이상의 경로 레벨과 일치하는 규정자를 포함할 수 있습니다.
매개변수의 이름만 지정하는 경우 해당 경로의 한 레벨이 일치합니다. 다중 레벨의 경로를 허용하려는 경우 다음 규정자 중 하나를 매개변수의 접두부로 사용할 수 있습니다.
- * 0이상의 발생을 표시합니다.
- +는 하나 이상의 발생을 표시합니다.
+및 * 규정자는 경로의 끝에서만 사용할 수 있습니다.
예를 들어, 경로는 다음과 같습니다.
/petstore/{type}/{*category}
다음 경로와 일치합니다. 여기서는 하나의 유형 값만 일치하지만 모든 (0이상) 카테고리가 일치합니다.
/petstore/cats
/petstore/cats/supplies
/petstore/cats/supplies/health
/petstore/cats/supplies/health/medicines
/petstore/cats/supplies/health/medicines/a/b/c
- 참조(기존 경로 편집 시 사용 가능): OpenAPI 정의 또는 외부
파일의 다른 곳에 정의되는 경로에 대한 참조입니다. 참조는 이 API 또는 전체 API 정의나 OpenAPI 단편인 파일에서
경로에 대해 이미 정의된 오퍼레이션의 세트 재사용을 가능하게 합니다.
참조는 JSON 포인터 표기법을 사용합니다. 예를
들면, 이 API에서
/mypath라는 경로에 대한 참조의 형식은 다음과 같습니다.
#/paths/~1mypath
~1 문자는
/ 문자를 이스케이프하는 데 사용되며, 특수 문자 대신에
경로 이름에서 글자 그대로 사용됩니다.
path_fragments.yaml라는 외부 파일의 경로에 대한 참조의 형식은
다음과 같습니다.
file://path_fragments.yaml/paths/~1mypath
- 요약: 이 경로의 모든 오퍼레이션에 적용하려는 선택적 요약입니다.
- 설명: 이 경로의 모든 오퍼레이션에 적용하려는 선택적 설명입니다. 서식있는 텍스트 표시에 CommonMark 구문 을 사용할 수 있습니다.
- 새 경로를 작성하는 경우 작성을 클릭하십시오.
4단계에 설명된 대로 추가 편집을 위해 경로 세부사항이 표시됩니다.
- 완료되면 저장 을 클릭하십시오.