OpenAPI를 TypeScript로 변환
YAML 또는 JSON 형식의 OpenAPI 3 또는 Swagger 2.0 문서에 있는 스키마에서 TypeScript 유형을 생성합니다. components.schemas 아래의 각 항목 또는 Swagger 2.0의 정의는 내보내는 인터페이스나 유형 별칭이 됩니다. $ref 간 참조는 유형 이름이 되고, nullable 필드에는 | null이 추가됩니다.
자주 묻는 질문
문서의 어떤 부분을 변환하나요?
OpenAPI 3의 components.schemas 아래 스키마와 Swagger 2.0의 definitions 아래 스키마입니다. 경로, 매개변수 및 응답은 유형으로 변환되지 않습니다. 생성된 스키마 유형을 직접 작성하는 요청 및 응답 코드에서 참조하세요.
스키마 이름은 어떻게 유형 이름으로 바뀌나요?
각 스키마 키는 PascalCase로 변환되므로 user-profile은 UserProfile이 됩니다. 두 키가 같은 이름으로 바뀌면 두 번째 이름에 숫자가 추가됩니다.
nullable 필드를 지원하나요?
예. OpenAPI 3.0의 nullable: true와 Swagger 2.0의 x-nullable: true는 | null을 추가하고, ["string", "null"] 같은 OpenAPI 3.1 유형 배열은 string | null이 됩니다.
도구가 확인할 수 없는 참조는 어떻게 처리되나요?
문서 외부를 가리키거나 components.schemas 또는 definitions의 스키마가 아닌 항목을 가리키는 $ref는 unknown이 되며 출력 상단의 주석에 표시됩니다.
YAML을 지원하나요?
예. 문서를 YAML 또는 JSON 형식으로 붙여넣으세요. YAML의 앵커와 별칭은 변환 전에 확장됩니다.
먼저 문서를 어떻게 검사하나요?
구조적 문제와 잘못된 참조를 표시하는 OpenAPI Validator를 사용하세요. 이 변환기는 스키마만 읽으며 다른 오류는 보고하지 않습니다.