가져온 API의 문제 감지하기

API(OpenAPI, Swagger 및 기타 지원되는 형식)를 가져오면 Restorm은 해당 API의 구조화된 문서를 변수 폴더에 보관합니다. 가져오기 직후, 그리고 파일을 다시 열 때마다 Restorm은 그 문서를 조용히 설계로 투영하고 API 디자이너가 적용하는 것과 동일한 검증을 전적으로 백그라운드에서 실행합니다. 가져오기를 차단하지 않으며 작업 중인 내용에도 전혀 영향을 주지 않습니다.

아무것도 발견되지 않으면 아무것도 표시되지 않습니다. 구조적 문제가 발견되면 두 곳에서 이를 알려 줍니다.

사이드바의 “!”

표시된 API를 담고 있는 변수 폴더는 해당 행의 오른쪽에 작은 **“!”**를 보여 줍니다. 이는 이 API의 설계에 살펴볼 만한 무언가가 있음을 한눈에 알리는 신호이며, API가 다시 정상 상태가 되면(다시 가져오기 또는 이를 수정하는 API 업데이트 후) 저절로 사라집니다.

“문제” 탭

변수 폴더를 열면 문제 탭이 추가됩니다. 이 탭은 문제가 감지되었을 때만 나타나며, 정상적인 API에서는 결코 표시되지 않습니다.

문제는 유형별로 묶이므로, 스무 개의 중복 라우트는 스무 개의 개별 항목이 아니라 개수가 표시된 한 줄로 읽힙니다. 각 유형 아래에서 Restorm은 관련된 정확한 엔터티를 나열합니다 — 라우트는 HTTP 동사와 실제 경로를 보여 주며, 해당 라우트의 문서까지 펼쳐지므로 탭을 벗어나지 않고도 무엇을 선언하는지 확인할 수 있습니다.

이 검사는 API 디자이너의 검사를 그대로 반영하므로, 볼 수 있는 문제 유형에는 다음이 포함됩니다.

• 중복 라우트 — 동일한 메서드와 경로에 응답하는 두 라우트;
• 누락된 응답 — 응답을 전혀 선언하지 않는 라우트;
• 예약된 경로 — Mock Server가 예약한 경로(/swagger.json, /graphql, …)에 있어 결코 응답하지 않을 라우트;
• 제약 조건 문제 — 유효하지 않은 패턴, 또는 최댓값보다 큰 최솟값.

이 목록은 읽기 전용입니다. 무엇을 고쳐야 하는지 알려 줄 뿐이며, 수정은 원본에서 이루어집니다(수정된 명세를 다시 가져오거나 API를 편집합니다). 이 목록은 API를 변경하는 이벤트 — 파일 열기, 가져오기, API 업데이트 — 마다 다시 계산되며, 모든 키 입력마다 계산되지는 않습니다.