Apidog의 APIs 모듈에는 인터페이스의 왼쪽 하단 모서리에서 전환할 수 있는 두 가지 모드가 있습니다. 디자인 우선 모드와 요청 우선 모드입니다.두 모드는 유사한 기능을 제공하지만 서로 다른 인터페이스를 갖추고 있어, 다양한 팀 워크플로에 맞게 사용할 수 있습니다.디자인 우선 모드는 Apidog에서 권장하는 모드로, API-Design First 접근 방식을 따르는 팀에 적합합니다. 이 모드에서는 팀이 먼저 API를 명세한 다음, API 명세를 기반으로 개발 및 테스트를 진행합니다.반면, 요청 우선 모드는 처음부터 API 사양을 정의하지 않는 팀에 적합합니다. 이러한 팀은 일반적으로 백엔드 개발에 집중하고 코드를 확정한 다음, 테스트 및 클라이언트 측 작업을 시작하기 위해 API 명세를 작성합니다.다른 사람이 개발한 API를 호출해야 하지만 문서가 없는 경우에도 요청 우선 모드를 사용해야 합니다.
디자인 우선 모드#
디자인 우선 모드에서는 API 명세 편집과 요청 전송이 별도의 탭을 통해 이루어집니다. 사용자는 Edit 탭에서 API 명세를 수정하고, Run 탭에서 요청을 전송합니다.이러한 분리는 API 설계자와 개발자/소비자의 역할이 구분되는 API-Design First 접근 방식을 따르는 팀에 적합합니다. API 설계자는 요청을 전송하지 않고 API 명세를 정의하며, 개발자는 API 명세를 변경하지 않고 API 개발 및 테스트에 집중합니다.분리된 탭은 이러한 팀의 사용 습관과 잘 맞습니다. Edit 탭에서 API 설계자는 요청 예제를 지정할 수 있으며, 이 예제는 Run 탭에서 기본 매개변수 값으로 자동 설정됩니다. API 개발자/소비자는 Run 탭에서 매개변수 값과 요청 본문을 추가로 수정할 수 있습니다.요청 우선 모드#
요청 우선 모드는 API를 사전에 명세하지 않는 팀에 적합합니다. 백엔드 개발자는 API 개발을 직접 진행하며, 개발 중 디버깅을 위해 API 호출이 필요할 수 있습니다.이 모드에서는 개발자가 처음부터 API를 명세할 필요가 없습니다. 대신 Postman에서 새 요청을 생성하는 것과 유사하게 요청을 직접 입력할 수 있습니다. 이 인터페이스에서는 API 명세와 요청 매개변수 값을 별도로 조정할 필요 없이, 개발자가 매개변수 유형, 이름, 값, 본문 구성 요소 등을 쉽게 수정할 수 있습니다.디버깅이 완료되어 저장되면 요청은 자동으로 엔드포인트 명세로 파싱됩니다. 매개변수는 명세 매개변수와 예제 값으로 변환되며, 요청/응답 본문은 스키마로 파싱되고 본문 값은 요청/응답 예제로 해석됩니다. 개발자는 요구 사항에 따라 이 엔드포인트 명세를 추가로 다듬고 보강할 수 있습니다.모드 간 차이점#
두 모드의 핵심 차이점은 요청 우선 모드에서는 요청 본문이 엔드포인트 요청 본문 예제로 사용된다는 점입니다. 반면, 디자인 우선 모드에서는 요청 본문 예제와 함께 Run 탭에서 실제 요청 본문을 입력할 수 있습니다. 따라서 Run 탭의 본문 섹션은 디자인 우선 모드에서만 사용할 수 있으며, 요청 우선 모드에서는 표시되지 않습니다.또 다른 차이점은 디자인 우선 모드에서는 엔드포인트 명세 수준 또는 실행/엔드포인트 케이스 수준에서 전/후 처리기를 추가할 수 있다는 점입니다. 반면, 요청 우선 모드에서는 Run 탭이 없으므로 모든 전/후 처리기가 엔드포인트 명세 수준에 있는 것으로 간주됩니다. 실행/엔드포인트 케이스 수준의 전/후 처리기는 요청 우선 모드에서 보이지 않습니다. 