OpenAPI 사양 생성

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

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

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

   {
     "plugins": [
       {
         "name": "OpenApiSpecGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll"
       }
     ]
     // [...] shortened for brevity
   }
   

2. 구성 파일에서 감시할 URL 목록에 OpenAPI 사양을 생성하려는 API의 URL을 추가합니다.

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

   팁

   더 나은 OpenAPI 사양을 만들려면 개발자 프록시와 함께 로컬 언어 모델을 사용하는 것이 좋습니다. 자세한 내용은 로컬 언어 모델 사용을 참조하세요.

3. 개발 프록시 시작:

   devproxy
   

4. 키를 눌러 녹음/녹화 요청 시작 r

5. OpenAPI 사양에 포함할 요청을 수행합니다.

6. 키를 눌러 녹음/녹화 요청 중지 s

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