많은 개발자들이 이전 블로그 "1분 안에 API 모킹하기"가 유용하다고 느꼈으며, 여러분도 그럴 수 있습니다. 그 블로그에서는 API를 모킹하는 빠른 방법을 다루었지만, 표면만 다뤘습니다. Apidog에 대해 더 깊이 파고들면서, 복잡한 데이터를 더욱 빠르게 모킹할 수 있는 추가 기능을 발견했습니다.
복잡한 JSON 데이터로 API 처리하기
먼저 Swagger API를 Apidog에 가져와 JSON 데이터를 모킹하는 방법부터 시작해보겠습니다. 이렇게 하면 스크립트 없이 모킹 데이터를 생성할 수 있습니다.
하지만 일부 필드는 추가 구성 없이는 모킹하기 어려울 수 있습니다. 예를 들어:
- 여러 가능한 값을 가진 Enum 필드, 주로 상태 필드에 사용됩니다.
- 정해진 길이의 배열, 각 행에 여러 속성이 있고, 페이지에 20 또는 50개의 행이 표시될 수 있는 표와 같은 것입니다.
- 스키마를 참조하는 객체, OpenAPI 사양에 따라 객체 또는 객체의 일부가 스키마를 참조하는 경우입니다.
다행히도, Apidog를 사용하면 이러한 복잡한 JSON 필드를 단 2분 만에 모킹할 수 있습니다.
복잡한 JSON 데이터를 빠르게 모킹하는 방법은？
다음은 Apidog를 사용하여 복잡한 API를 모킹하는 간단한 세 단계 프로세스입니다:
- API 정의 가져오기.
- 특정 필드에 대한 API 모킹 규칙 사용자 지정.
- 모킹 URL 가져오기.
이렇게 간단합니다. 함께 진행해봅시다.
1단계: API 정의 가져오기
OpenAPI JSON 또는 YAML 파일만 필요합니다. Apidog에 가져오기하고 준비가 완료되었습니다.
2단계: 특정 필드에 대한 API 모킹 규칙 사용자 지정
Enum 값:
우리 샘플 API에서 'status' 필드는 세 가지 옵션을 가집니다: available, pending, sold. 우리는 모킹 데이터가 이러한 값 중 하나만 반영되기를 원합니다.
'Status' 필드에서 '고급 설정'을 클릭하고 'Enum' 스위치를 활성화한 후 enum 값을 추가하세요. 이제 이 필드는 이 값 중 하나만 모킹됩니다.
정해진 길이의 배열:
'PhotoUrls' 배열 필드의 경우 정확히 다섯 개의 항목이 필요합니다.
'PhotoUrls' 필드의 '고급 설정'에서 '요소 제한' 설정을 조정하세요. 'minItems'와 'maxItems'를 모두 5로 설정합니다.
스키마 참조 객체:
Apidog은 OpenAPI 사양에 따라 스키마를 지원합니다. 객체가 스키마를 참조하는 경우 Apidog는 그에 따라 모킹합니다. 예를 들어, 'Category' 필드의 스키마를 참조할 수 있습니다.
3단계: API 모킹 URL 가져오기
‘저장’ 버튼을 클릭하고 'Endpoint' 탭으로 전환하세요. "Local Mock" 섹션 아래의 URL을 복사하세요. 이 URL은 "127.0.0.1"로 시작합니다.
브라우저에 URL을 붙여넣고 완료입니다.
주목할 만한 필드
모킹 데이터를 확인하면 다음을 알 수 있습니다:
- PhotoUrls는 정확히 5개의 항목이 있으며, 모두 유효한 이미지 URL을 가지고 있습니다.
- Status는 enum 값 중 하나로 제한됩니다 (sold, pending 또는 available).
- Category는 올바른 스키마를 참조합니다.
기타 필드, 예를 들어 city와 createdAt는 자동으로 모킹됩니다.
그리고 URL을 새로 고치면 모킹 데이터가 업데이트됩니다.
Apidog는 API를 위한 JSON 스키마 모킹을 지원합니다
Apidog는 API 데이터를 정의하기 위해 JSON 스키마를 사용하는 OpenAPI 3.0과 완벽하게 호환됩니다. 모든 JSON 스키마 속성이 Apidog에서 지원되며, 여기에는:
- 문자열 길이 범위, 형식 및 패턴(정규 표현식)
- 최소 및 최대 정수 값
- 읽기 전용/쓰기 전용 설정
JSON뿐만 아니라 Apidog는 XML 모킹도 지원합니다. XML 태그 이름과 접두사를 사용자 지정할 수도 있습니다.
JSON 스키마 덕분에 클릭 몇 번으로 복잡한 모킹 데이터를 생성할 수 있으며, 코딩이 필요 없습니다.
