OpenAPI 사양 생성

한눈에 보기
목표: 가로챈 API 요청으로부터 OpenAPI 사양 생성하기
시간: 10분
Plugins:OpenApiSpecGeneratorPlugin
필수 구성 요소:개발 프록시 설정

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

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

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

   파일: devproxyrc.json

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

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

   파일: devproxyrc.json

   { 
     "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같습니다.

참고하십시오

• OpenApiSpecGeneratorPlugin - 전체 참조
• 로컬 언어 모델 사용 - 생성된 사양 개선
• OpenAPI 사양이란 ? - 개념
• 용어집 - 개발자 프록시 용어