API 도구

OpenAPI Mock 데이터 생성명세에 연결된 테스트 본문

작업과 본문을 고른 뒤 명세의 예시를 쓰거나 스키마에서 생성하세요.

OpenAPI Mock 데이터 생성

OpenAPI 명세

생성 결과

명세와 본문은 이 브라우저에만 머물며 API 요청을 보내지 않습니다.

생성 옵션

JSON 한 건은 원래 형태를 유지하고 배치는 외부 배열로 묶습니다. JSONL은 한 줄에 본문 하나입니다.

작업 목록 읽는 중…

API 구현을 기다리는 동안에도 화면의 성공과 실패 경로는 테스트해야 합니다. OpenAPI Mock 데이터 생성은 각 픽스처를 명세의 작업 및 상태 코드에 연결해, 성공 응답을 대충 수정한 데이터가 오류 테스트에 섞이지 않도록 돕습니다.

OpenAPI 스키마를 이용한 가짜 데이터 생성에서 수량은 완전한 본문의 개수입니다. 응답 자체가 배열이면 배열 길이는 items와 관련 제약으로 정해지며, 화면에서 설정한 배치 수량과는 다릅니다.

OpenAPI Mock 데이터 생성 활용

오류 상태의 예시도 직접 선택

OpenAPI Mock 데이터 생성에서는 200뿐 아니라 명세에 정의된 400, 404, default도 선택할 수 있습니다. 이름 있는 예시를 바꾸면 명세 자체를 수정하지 않고 여러 결과를 비교할 수 있습니다. 다른 상태의 예시는 현재 결과에 섞이지 않습니다.

하나의 작업에서 여러 응답 카드로 갈라지고 예시 하나가 선택된 모습.

동일한 배치를 다시 만들기

예시 우선을 끄고 시드를 고정하면 같은 명세와 설정으로 동일한 데이터 묶음을 재현할 수 있습니다. 엔진 버전도 함께 기록하세요. 명시된 예시나 상수는 고정된 값이므로 시드를 바꿔도 달라지지 않을 수 있습니다.

동일한 시드 두 개에서 순서와 색이 같은 본문 배치가 생성되는 모습.

본문을 바꾸는 세 가지 설정

01

요청과 응답 방향 구분

처음 표시되는 YAML 예시는 자동으로 작업 목록에 반영됩니다. 요청 방향은 requestBody만 만들고, 응답 방향은 상태와 미디어 유형에 맞는 본문을 만듭니다. URL, 쿼리, 헤더 매개변수는 포함하지 않습니다.

02

예시 우선의 의미 확인

미디어의 example과 이름 있는 examples가 스키마 및 속성 예시보다 먼저 적용됩니다. 잘못된 예시는 생성 오류로 남으며 임의 값으로 바뀌지 않습니다. 다른 값을 샘플링하려면 예시 우선을 끄세요.

03

단일 본문과 배치 구별

JSON 한 건은 원래 본문 형태를 유지합니다. 여러 건은 외부 배열로 묶고 JSONL은 한 줄에 본문 하나를 저장합니다. Ctrl/Cmd + Enter로 실행할 수 있고 입력이나 옵션을 바꾸면 재생성 전까지 내보내기가 잠깁니다.

요청 응답 예시를 계약에 맞게

작업별 상태 선택

메서드와 경로로 작업을 찾고 선언된 응답 코드, 범위 또는 default를 선택합니다. 기본 응답은 200, 다른 2xx, 첫 항목 순으로 정합니다. 성공 사례와 오류 사례를 같은 절차로 준비할 수 있습니다.

예시에도 검증 적용

인라인 값과 이름 있는 예시, 같은 문서의 Example Object 참조를 읽습니다. 적용 가능한 스키마와 속성 예시도 사용합니다. examples에 들어 있다는 이유만으로 신뢰하지 않고 각 출력 본문을 검증합니다.

방향에 맞는 속성

요청에서는 readOnly, 응답에서는 writeOnly 속성을 제외하고 해당 방향의 required를 조정합니다. 사용자가 제공한 예시에 제외할 속성이 있으면 오류로 처리하며, 조용히 삭제하고 내보내지 않습니다.

시드로 관리하는 배치

1–100개의 독립된 본문으로 Mock 데이터를 준비할 수 있습니다. uniqueItems는 각 본문 안의 배열에 적용되므로 배치 전체의 중복 금지를 뜻하지 않습니다. 수량을 늘려도 본문 자체의 배열 제약은 유지됩니다.

지원 범위와 중단 조건

지원 버전의 JSON 본문
하나의 JSON 또는 YAML 문서로 된 OpenAPI 3.0.x와 3.1.x를 받습니다. Swagger 2와 OpenAPI 3.2는 지원하지 않습니다. application/json 및 application/*+json 본문만 생성하며 XML, 폼, 바이너리, 콜백과 Webhook 실행은 제외합니다.
제약을 무시하지 않음
type, enum/const, properties, required, additionalProperties, items, uniqueItems와 숫자 및 크기 경계를 지원합니다. 3.0 nullable과 배타적 경계는 변환합니다. 조합, 조건, pattern, format, multipleOf, 튜플, 알 수 없는 검증 키워드는 예시가 있어도 생성을 중단합니다.
참조는 한 문서 안에서
로컬 JSON Pointer로 스키마와 예시를 찾습니다. 외부 URL, externalValue, 순환, 앵커, 리소스 ID, 동적 참조는 확장하지 않습니다. 3.1 스키마 참조 옆에 추가 검증 제약이 있으면 잘못 덮어쓰지 않고 거부합니다.
빈 응답을 만들어 내지 않음
content가 없는 응답은 본문 없음으로 표시하며 null 파일을 만들지 않습니다. JSON 미디어에 schema가 없으면 오류입니다. default는 예시로 취급하지 않고 필드 이름으로 실제 이름이나 이메일을 추측하지 않으며 확장 스크립트도 실행하지 않습니다.
명확한 생성 예산
입력은 500000자까지입니다. 확장된 생성 스키마는 100000자, 구문 노드 2000개, 컨테이너 포함 깊이 12까지입니다. 문자열은 1000단위, 컬렉션은 100개, 출력은 1000000자, 작업 스레드는 5초가 한도입니다. 시드는 0–4294967295의 정수이며 중복 키, 숫자 정밀도 손실, YAML 별칭은 거부합니다.
실행 중인 API가 아님
다운로드되는 것은 데이터 파일입니다. 엔드포인트 URL, HTTP 서버, 인증, 영구 CRUD, MSW나 Express 코드는 제공하지 않습니다. 실제 서버 계약 테스트도 아닙니다. 예산 안에서 결과를 못 찾았다고 해서 해당 스키마의 유효 값이 존재하지 않는 것은 아닙니다.

OpenAPI Mock 데이터 생성 질문

OpenAPI 정의에서 JSON 예시를 어떻게 만드나요?

지원하는 전체 명세를 붙여 넣고 작업, 방향, 미디어 유형을 고릅니다. 문서의 예시를 사용하려면 우선 옵션을 켜 두고, 스키마의 다른 값을 생성하려면 끕니다. 독립된 스키마만 있다면 전용 스키마 데이터 도구가 적합합니다.

특정 응답 예시는 어떻게 선택하나요?

응답 상태와 JSON 미디어를 먼저 고른 뒤 그 위치의 이름 있는 예시를 선택하세요. 인라인 값과 동일 문서의 Example Object 참조를 지원하며 미디어 예시가 스키마 예시보다 우선합니다.

오류 응답도 생성할 수 있나요?

명세에 해당 응답과 지원되는 JSON 스키마가 있으면 가능합니다. 400이나 404를 고르면 그 본문을 테스트 픽스처로 만듭니다. 실제 HTTP 오류를 전송하거나 서버 장애를 일으키지는 않습니다.

왜 매번 결과가 같나요?

기본 시드는 42입니다. 명세와 설정이 같으면 샘플링 결과를 재현합니다. example, const, 단일 값 enum은 시드와 관계없이 같을 수 있습니다. 먼저 예시 우선을 끈 다음 시드를 변경해 보세요.

생성된 Mock이 실제 요청을 검증하나요?

검증 대상은 제공되거나 생성된 본문과 지원하는 유효 스키마입니다. API에 접속하거나 미들웨어를 실행하지 않으며 실제 헤더, 인증 및 업무 규칙은 확인하지 않습니다.

추가로 지원했으면 하는 제약이 있나요?

다음 테스트의 본문 준비

OpenAPI Mock 데이터 생성으로 먼저 한 건을 만들고 상태와 출처를 확인하세요. 테스트에 배치가 필요할 때 수량을 늘리면 됩니다.