현재 대부분의 API는 메서드와 경로를 기준으로 구분됩니다. 그러나 일부 개발 프로젝트(예: 일부 이커머스 API 문서)에서는 API 요청에 고정 URL을 사용하고, Query / Header의 매개변수를 사용하여 API를 구분합니다.버전 2.2.9 이후 Apidog에는 엔드포인트 고유 식별 기능이 추가되었으며, API를 구분하기 위한 매개변수로 OperationId, Query 매개변수, Body 매개변수, Header 매개변수를 지원합니다.엔드포인트 고유 식별 설정#
엔드포인트 고유 ID는 디렉터리 수준에서 정의됩니다. API를 고유 식별로 설정해야 하는 경우 해당 API의 상위 디렉터리에서 설정해야 합니다. 디렉터리를 클릭하고 필요에 따라 고유 식별 매개변수를 선택한 다음, 저장을 클릭하면 해당 디렉터리 아래의 모든 API에 적용됩니다.이 예시에서는 Query 매개변수를 선택하고 param name에 OperationID를 입력하겠습니다.해당 매개변수 값 입력#
디렉터리에 대한 엔드포인트 고유 식별을 설정한 후, 해당 디렉터리 아래의 API를 클릭하고 operationid 탭을 클릭하면 API 하단의 기본 정보와 요청 매개변수 모두에 K 아이콘이 표시됩니다. 이 아이콘은 엔드포인트 고유 ID의 매개변수를 나타냅니다.해당 매개변수 아래에 엔드포인트 고유 식별 값으로 사용할 해당 값을 입력할 수 있습니다.고유 식별을 사용하여 가져오기#
프로젝트에서 Query/Header의 매개변수를 사용하여 API를 구분하고 OpenAPI 형식의 파일을 Apidog로 가져오는 경우, 다음 페이지가 표시됩니다.가져오기 중 API 매칭 규칙은 대상 디렉터리의 설정을 따릅니다. 대상 디렉터리의 엔드포인트 고유 식별 설정이 요구 사항을 충족하지 않는 경우, 가져오기 설정에서 수정할 수 있습니다. 수정 후에는 대상 디렉터리에 즉시 적용됩니다.예시로 이 디렉터리를 가져오고, Query Param 및 action이라는 Param Name으로 엔드포인트 고유 ID를 생성하겠습니다.디렉터리에 이미 고유 ID가 있는 경우, 새 가져오기로 이를 덮어쓸 수 없다는 점을 기억하십시오.
1.
Query 매개변수에서 Fixed Value를 사용한 사용자는 걱정하지 않으셔도 됩니다. 이 기능은 계속 유지됩니다. 그러나 가져오기 시 Fixed Value는 URL을 기준으로 판단되므로, Fixed Value를 사용한 사용자는 엔드포인트 고유 식별을 사용하는 것이 좋습니다.
2.
엔드포인트 고유 식별은 여러 매개변수 설정을 지원합니다.
3.
디렉터리의 하위 디렉터리만 엔드포인트 고유 식별로 설정된 경우, Swagger를 가져와 모든 디렉터리를 업데이트할 때 업데이트를 위해 모든 프로젝트를 루트 디렉터리로 가져오는 것을 피하십시오. 엔드포인트 고유 식별로 설정된 API는 해당 특수 디렉터리로 별도로 가져오는 것이 좋습니다.
목 데이터#
버전 2.2.24부터 API가 고유 식별자를 Body Parameter 또는 Header Parameter로 설정한 경우, 해당 목 데이터를 가져오려면 경로 + 고유 식별자의 매개변수 이름 및 값을 전송해야 합니다.1.
개발 중 목 데이터에 접근할 때, API가 고유 식별자를 Body Parameter 또는 Header Parameter로 설정한 경우 프런트엔드 개발자도 경로 + 고유 식별자의 매개변수 이름 및 값을 전송해야 합니다.
2.
API에 고유 식별자가 있는 프로젝트의 경우, API 문서를 표준화하여 동일한 URL을 가진 API에 고유 식별자가 설정되지 않은 사례를 방지해야 합니다. 이는 목 데이터를 올바르게 가져오지 못하는 상황을 방지하기 위한 것입니다.
