Orval Connector

VSCode에서 Orval 설정을 쉽게 생성하고 관리할 수 있는 확장 프로그램입니다.

Orval 공식 웹사이트: https://orval.dev/

주요 기능

• 다중 OpenAPI YAML 파일 관리 및 자동 다운로드
• AI 기반 프로젝트 맞춤형 Orval 설정 생성
• 프로젝트 구조와 의존성 자동 분석
• TypeScript 기반 타입 안전성 보장

설치 방법

1. VSCode 마켓플레이스에서 "Orval Connector" 검색
2. Install 버튼 클릭
3. VSCode 재시작

설정

VSCode 설정(Settings)에서 "Orval Connector" 검색 후 다음 설정을 완료해주세요:

1. YAML 설정 (orvalConnector.yamlUrls)

여러 개의 YAML 파일을 관리할 수 있습니다. 각 YAML 설정은 다음 형식을 따릅니다:

{
  "orvalConnector.yamlUrls": [
    {
      // YAML 선택 시 표시될 이름
      "name": "회원 API",
      // YAML 파일 URL
      "url": "https://api.example.com/member/openapi.yaml",
      // 저장될 파일명
      "fileName": "member.yaml",
      // 저장 경로 (선택사항, 기본값: "./")
      "savePath": "./api/member"
    }
  ]
}

2. OpenAI 설정

• orvalConnector.openaiApiKey: OpenAI API Key
• orvalConnector.openaiModel: 사용할 모델 (기본값: "o3-mini")

사용 방법

YAML 파일 다운로드

1. Cmd+Shift+P (Mac) / Ctrl+Shift+P (Windows)
2. "Orval: Update YAML Only" 실행
3. 목록에서 원하는 YAML 선택

Orval 설정 생성

1. Cmd+Shift+P (Mac) / Ctrl+Shift+P (Windows)
2. "Orval: Generate Config with AI" 실행
3. 목록에서 원하는 YAML 선택
4. AI가 프로젝트를 분석하여 최적화된 설정 생성

지원 기능

클라이언트

• React Query
• SWR
• Vue Query
• Svelte Query
• Axios

데이터 검증

• Zod

Mocking

• MSW
• JSON

문제 해결

다음 사항을 확인해주세요:

1. YAML URL 설정이 올바른지 확인
2. OpenAI API Key가 유효한지 확인
3. 프로젝트 루트 디렉토리에서 실행했는지 확인

라이선스

GPL-3.0