튜토리얼: Apigee 및 Cloud Code에서 Gemini Code Assist를 사용하여 API 설계, 개발, 테스트

이 페이지는 Apigee 및 Apigee Hybrid에 적용됩니다.

개요

이 튜토리얼에서는 Cloud Code에서 Gemini Code Assist를 사용하여 API를 설계하고 생성된 API 사양으로 Apigee API 프록시를 만드는 과정을 안내합니다. 이 튜토리얼에서는 자연어 프롬프트를 사용하여 웹사이트의 스포츠 관련 블로그 게시물을 관리하는 API를 설계하고 생성합니다.

시작하기 전에

이 튜토리얼을 완료하려면 다음이 필요합니다.

  • Apigee 프로젝트에 Gemini for Google Cloud API가 설정되어 있거나 이를 추가할 수 있도록 Apigee 조직 관리자여야 합니다. Gemini Code Assist 설정 단계는 Gemini Code Assist 사용을 참조하세요.
  • Apigee 프로젝트의 Apigee API 관리자여야 합니다.
  • Cloud Code에서 Apigee 프로젝트의 로컬 개발을 아직 설정하지 않았으면 지금 설정합니다. VS Code용 Cloud Code에서 Apigee API 관리 설정을 참조하세요.
  • 생성된 사양을 검토할 수 있도록 OpenAPI 사양에 대한 기본 지식이 필요합니다.
  • (선택사항) 이 프로젝트에 API 허브가 설정되어 있습니다. 여기에서 설명하는 Gemini Code Assist 기능을 사용하는 데 반드시 필요하지는 않지만 API 허브가 없으면 일부 단계를 수행할 수 없습니다.

1단계: Cloud Code에서 Apigee 로드

VS Code를 열고 Cloud Code 아이콘을 클릭합니다. Apigee 프로젝트 및 모든 API가 표시됩니다.

Cloud Code Gemini Code Assist 왼쪽 메뉴

2단계: API 사양 만들기 탭을 열고 프롬프트 입력

Apigee 행에서 마법 지팡이를 클릭하여 사양 생성 탭을 엽니다.

Cloud Code Gemini Code Assist 사양 만들기 마법 지팡이

탭에는 API 프롬프트를 시작하는 데 사용할 수 있는 템플릿이 표시됩니다. 그 아래에 자유 형식 프롬프트 입력란이 제공됩니다. 블로그 콘텐츠용 API를 클릭합니다. 프롬프트 입력란에 이 API를 설명하는 자연어 프롬프트가 채워집니다.

Cloud Code Gemini Code Assist 사양 만들기 양식

3단계: 사양 만들기 및 보기

만들기를 클릭하여 이 프롬프트로 API 사양을 생성합니다. 사양이 생성되는 동안 기다립니다. 사양이 생성되면서 출력 패널에 단계가 표시됩니다.

생성이 완료되면 아래로 스크롤하여 사양 설명, 엔드포인트, 스키마를 확인합니다. OpenAPI 사양 코드를 보려면 코드 보기를 클릭합니다.

Cloud Code Gemini Code Assist 사양 엔드포인트

4단계: 프롬프트 수정 및 사양 다시 만들기

프롬프트로 돌아가서 스포츠 유형을 데이터 객체의 일부로 추가합니다.

Cloud Code Gemini Code Assist의 수정된 프롬프트

만들기를 다시 클릭하여 사양을 다시 생성합니다. 업데이트된 사양에 스포츠 유형이 표시됩니다.

프롬프트 입력 상자 상단의 프롬프트 기록을 클릭하여 이전 프롬프트로 돌아갈 수도 있습니다.

5단계: 사양 수정

코드 보기를 클릭하고 사양에 직접 업데이트를 입력하여 사양을 변경할 수 있습니다. 이 예시에서는 설명을 '스포츠 블로그 게시물 콘텐츠 관리 API'로 변경합니다.

Cloud Code Gemini Code Assist의 수정된 코드

6단계: 모의 서버를 사용하여 API 테스트

API 응답을 에뮬레이션하는 로컬 모의 서버를 사용하여 API를 테스트합니다. 서버 드롭다운에서 이름이 로컬 개발 서버인 옵션을 선택합니다. 선택한 후 POST 경로를 열고 사용해 보기를 클릭합니다.

요청 본문에서 'author', 'content', 'title' 값을 수정하여 원하는 값을 사용할 수 있습니다.

{
    "author": "My name",
    "categories": [
      "string"
    ],
    "content": "This is my blog post",
    "featuredImageUrl": "string",
    "publishedDate": "string",
    "tags": [
      "string"
    ],
    "title": "Baseball in the age of AI"
  }

실행을 클릭하여 응답 섹션에서 API의 모의 응답을 확인합니다.

7단계: API 허브에 API 저장

(선택사항) API를 검토하고 완료한 후에는 이를 API 허브에 등록하여 개발자에게 제공합니다.

  1. API 허브에 등록을 클릭합니다.
  2. 안내에 따라 API를 등록합니다. API 허브 등록 관련 정보와 제공해야 하는 정보에 대해서는 API 등록을 참조하세요.

저장을 클릭하여 새로운 API를 선택한 이름으로 저장합니다.

8단계: 이 사양으로 API 프록시 번들 만들기

이 사양으로 Apigee API 프록시 번들을 만들려면 더보기 메뉴에서 API 프록시 번들 만들기를 클릭합니다. 생성된 후 왼쪽 메뉴의 apiproxies 아래에 새 프록시가 표시됩니다. Cloud Code에서의 API 프록시 작업에 대한 자세한 내용은 API 프록시 개발을 참조하세요.
Cloud Code Gemini Code Assist API 프록시 번들 만들기

다음 단계