TypeSpec 파일 생성

개발자 프록시를 사용하면 가로채는 API 요청 및 응답에서 TypeSpec 파일을 생성할 수 있습니다. 개발자 프록시를 사용하면 기존 API에 대한 TypeSpec 파일을 빠르게 만들고 TypeSpec을 지원하는 도구를 활용할 수 있습니다.

개발 프록시를 사용하여 TypeSpec 파일을 생성하려면 다음을 수행합니다.

1. 구성 파일에서 플러그 인을 TypeSpecGeneratorPlugin 사용하도록 설정합니다.

   {
     "plugins": [
       {
         "name": "TypeSpecGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll"
       }
     ]
     // [...] shortened for brevity
   }
   

2. 필요에 따라 구성 파일에서 플러그 인을 구성합니다.

   {
     "typeSpecGeneratorPlugin": {
       "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/typespecgeneratorplugin.schema.json",
       "ignoreResponseTypes": false
     }
     // [...] shortened for brevity
   }
   

3. 구성 파일에서 감시할 URL 목록에 TypeSpec 파일을 생성할 API의 URL을 추가합니다.

   { 
     "urlsToWatch": [
       "https://api.example.com/*",
     ]
     // [...] shortened for brevity
   }
   

   팁 (조언)

   더 나은 TypeSpec 파일을 만들려면 개발자 프록시와 함께 로컬 언어 모델을 사용하는 것이 좋습니다. 로컬 언어 모델을 사용하여 TypeSpecGeneratorPlugin은 보다 명확한 작업 ID와 설명을 생성하여 TypeSpec 파일에 대한 더 나은 시작점을 제공합니다. 자세한 내용은 로컬 언어 모델 사용을 참조하세요.

4. 개발 프록시 시작:

   devproxy
   

5. r 버튼을 눌러 요청 기록 시작

6. TypeSpec 파일에 포함할 요청을 수행합니다.

7. s를 눌러 녹음 요청을 중지하세요.

8. 개발 프록시는 TypeSpec 파일을 생성하고 현재 디렉터리의 파일에 저장합니다. 개발자 프록시는 API의 호스트 이름 뒤에 현재 날짜 및 시간 뒤에 파일 이름을 지정합니다. 예를 들면 다음과 api.example.com-20231219091700.tsp같습니다.

다음 단계

TypeSpecGeneratorPlugin에 대해 자세히 알아봅니다.

TypeSpecGenerator플러그인