Azure용 GitHub Copilot용 API 센터 플러그 인을 사용하여 API 디자인 및 개발
Azure용 GitHub Copilot(미리 보기)용 API 센터 플러그 인은 자연어 프롬프트에서 시작하는 새로운 API의 디자인 및 개발을 가속화합니다. API 센터 VS Code 확장과 결합된 API 센터 플러그 인을 통해 사용할 수 있는 AI 지원을 사용하면 API를 설명하고 조직의 표준을 준수하는 API 개발을 위한 OpenAPI 사양을 신속하게 생성할 수 있습니다. 규격 사양을 생성한 후 API 센터에 API를 등록할 수 있습니다.
참고 항목
이 기능은 API 센터 확장의 시험판 버전에서 사용할 수 있습니다.
필수 조건
Azure 구독에 하나 이상의 API 센터가 있습니다.
- 현재 확장으로 API를 관리하려면 API 센터에 대한 Azure API 센터 서비스 기여자 역할 이상의 권한을 할당받아야 합니다.
- Azure용 GitHub Copilot - Azure용 GitHub Copilot용 Azure API 센터 플러그 인을 사용하여 OpenAPI 사양 파일을 생성합니다(미리 보기).
확장 설정
Visual Studio Code Marketplace에서 Visual Studio Code용 Azure API 센터 확장을 설치합니다. 필수 구성 요소에 나열된 다른 확장을 설치합니다.
참고 항목
명시된 경우 특정 기능은 Azure API Center 확장의 시험판 버전에서만 사용할 수 있습니다. Visual Studio Code Marketplace의 확장을 설치할 때는 릴리스 버전 또는 시험판 버전을 설치하도록 선택할 수 있습니다. 확장 보기에서 확장의 관리 단추 상황에 맞는 메뉴를 사용하여 언제든지 두 버전 간을 전환합니다.
Visual Studio Code의 왼쪽 작업 표시줄에서 API 센터를 선택합니다.
Azure 계정에 로그인되어 있지 않은 경우 Azure에 로그인...을 선택하고 프롬프트에 따라 로그인합니다. API를 보려는 API 센터(또는 API 센터)를 사용하여 Azure 구독을 선택합니다. 볼 구독이 많은 경우 특정 구독을 필터링할 수도 있습니다.
에이전트에 @azure 요청
다음 단계에 따라 Azure용 GitHub Copilot에서 자연어 프롬프트를 사용하여 OpenAPI 사양을 생성합니다.
원하는 경우 Azure API 센터 확장에서 활성 API 스타일 가이드를 설정합니다. 명령 팔레트를 열려면 Ctrl+Shift+P 바로 가기 키를 사용합니다. Azure API 센터 유형 : API 스타일 가이드를 설정하고, 선택하고, Enter 키를 누릅니 다.
스타일 가이드가 설정되지 않은 경우 기본
spectral:oas규칙 집합이 사용됩니다. API 센터 확장을 사용하는 API 사양 Linting에 대해 자세히 알아봅니다.채팅 패널에서 API가 수행하는 작업을 설명하기 위해
@azure에이전트에 자연어로 요청합니다. 예시:@azure Generate an OpenAPI spec: An API that allows customers to pay for an order using various payment methods such as cash, checks, credit cards, and debit cards. Check that there are no duplicate keys.부조종사에는 AI가 지원되므로 놀라움과 실수가 가능합니다. 자세한 내용은 코필로트 FAQ를 참조하세요.
에이전트는 OpenAPI 사양 문서로 응답합니다.
생성된 출력에서 API 스타일 가이드의 정확도, 완전성 및 규정 준수를 검토합니다.
필요한 경우 프롬프트를 구체화하여 사양을 다시 생성하거나 Azure API Center 확장에서 설정한 다른 스타일 가이드를 사용하여 프로세스를 반복합니다.
팁
효과적인 프롬프트는 구현 세부 정보보다는 API의 비즈니스 요구 사항에 초점을 맞춥니다. 더 짧은 프롬프트는 경우에 따라 더 긴 프롬프트보다 더 잘 작동합니다.
요구 사항을 충족하는 경우 생성된 OpenAPI 사양을 파일에 저장합니다.
API 센터에 API 등록
VS Code용 Azure API Center 확장을 사용하여 생성된 사양 파일에서 API 센터에 API를 등록합니다. API를 등록한 후 확장을 사용하여 API 설명서를 보고, HTTP 클라이언트를 생성하고, 추가 린팅 및 분석 등을 수행할 수 있습니다.
VS Code에서 채팅 패널의 API 센터 단추에 API 등록을 선택하거나, Azure API 센터: 명령 팔레트에서 API 등록을 선택합니다.
수동을 선택합니다.
API를 등록할 API 센터를 선택합니다.
API 등록을 완료하기 위해 API 제목, 형식, 버전 제목, 버전 수명 주기, 정의 제목, 사양 이름 및 정의(사양) 파일을 비롯한 정보가 포함된 메시지에 응답합니다.
API가 등록되면 확장을 사용하여 다양한 작업을 수행할 수 있습니다. 예를 들어 Swagger UI에서 API 설명서를 봅니다.
API 센터 트리 뷰를 확장하여 등록한 API 버전에 대한 정의를 선택합니다.
정의를 마우스 오른쪽 단추로 클릭하고 API 문서 열기를 선택합니다. API 정의에 대한 Swagger UI가 있는 새 탭이 표시됩니다.
