API 요청을 성공적으로 전송한 후, Apidog는 요청 및 응답 데이터를 자동으로 파싱하여 완전한 엔드포인트 사양을 생성할 수 있습니다. 이 강력한 기능은 시간을 절약해 주며, API 문서가 실제 동작을 정확하게 반영하도록 보장합니다.요청을 엔드포인트 사양으로 파싱하기#
성공적으로 전송된 요청이 아직 정의되지 않은 경우, Apidog에서 해당 요청을 엔드포인트 사양으로 자동 파싱할 수 있습니다.요청을 전송한 후 Save 버튼 옆의 드롭다운을 클릭하고 Save as endpoint를 선택하여 엔드포인트 사양으로 저장할 수 있습니다.요청을 엔드포인트로 저장하면 Apidog는 다음 정보를 지능적으로 추출합니다.요청 매개변수: 현재 요청의 요청 params 유형은 엔드포인트의 요청 매개변수 사양으로 처리되며, 현재 매개변수 값은 요청 매개변수의 예시 값으로 간주됩니다.
응답 스키마: 현재 요청의 응답 데이터 구조는 응답 사양으로 파싱되며, 응답 값은 응답 예시로 처리됩니다.
이 기능은 기존 API로 작업하거나 스키마를 수동으로 정의하는 대신 실제 요청/응답 데이터를 기반으로 API를 빠르게 문서화하려는 경우 특히 유용합니다.
응답 추출하기#
Apidog는 응답을 엔드포인트 사양으로 추출하는 것을 지원하며, 응답 스키마 또는 응답 예시로 추출할 수 있습니다.이러한 유연성 덕분에 엔드포인트의 스키마 정의를 업데이트할지, 아니면 문서화 및 테스트 목적을 위해 새 응답 예시만 추가할지 선택할 수 있습니다.응답을 스키마로 추출하는 것은 API 구조가 변경된 경우 유용하며, 예시로 추출하는 것은 다양한 응답 시나리오(성공, 오류, 엣지 케이스)를 문서화하는 데 더 적합합니다.