API 설계 및 수정

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

이 페이지의 안내에 따라 Cloud Code를 사용하여 API를 설계하고 수정하세요.

Gemini Code Assist로 API 설계

Cloud Code를 사용하여 OpenAPI 사양(OAS), 버전 3.0 API를 설계할 수 있습니다. Gemini Code Assist는 API 개발 프로세스에 생성형 AI 어시스턴스에 대한 엔터프라이즈 컨텍스트를 포함할 수 있습니다. 엔터프라이즈 컨텍스트는 새 API를 생성할 때 프로젝트의 API 허브 API를 컨텍스트로 사용하며, API 허브를 사용하는 프로젝트에서만 제공됩니다.

이 섹션의 기능을 사용하기 위한 설정 단계는 Gemini Code Assist 사용을 참조하세요.

API를 생성하려면 다음 단계를 수행합니다.

왼쪽 탐색 메뉴에서 마법 지팡이를 클릭하여 Gemini Code Assist를 사용해 새로운 API 사양을 만듭니다. API 사양을 만들 때 전체 기능을 완전히 지원하지 않는 Gemini Code Assist 채팅 대신 이 방법을 사용하여 API 사양을 만들어야 합니다.
API 사양 만들기 입력 창에 새 API를 설명하는 프롬프트를 입력합니다.
1. 원하는 경우 표시된 템플릿 칩에서 프롬프트 템플릿을 선택합니다. 프롬프트 템플릿은 작업을 시작하는 데 도움이 되는 프롬프트 프레임워크를 제공합니다.
2. 프롬프트를 입력합니다. 효과적인 API 사양 프롬프트를 작성하는 방법을 참조하세요.
Gemini Code Assist는 API를 정의하는 OAS를 생성합니다.
사양을 검토합니다.
1. 코드 보기를 클릭하여 코드 편집기에서 사양을 검토합니다.
2. API 렌더러 패널은 API 설명 및 기타 문서를 포함하여 개발자가 검토할 수 있도록 API 미리보기를 표시합니다.
3. API 허브에 API가 이미 있는 경우 해당 엔터프라이즈 컨텍스트는 다른 API의 객체를 이 OAS에 재사용하는 데 사용되며 OUTPUT 패널에 나열됩니다.
4. 의견을 보내주셔서 감사합니다. Swagger 패널에서 좋아요 또는 싫어요 아이콘을 클릭하여 생성된 사양에 대한 의견을 알려주세요.
5. 미리보기 프롬프트를 수정하고 사양을 다시 생성하려면 프롬프트 위에서 프롬프트 기록 화살표를 클릭하여 이전 프롬프트 사이로 이동합니다.
사양을 테스트합니다. 새 사양이 완료되면 모의 서버를 사용하여 테스트할 수 있습니다. 모의 서버를 사용하여 API 테스트를 참조하세요.
저장을 클릭하여 새로운 API를 선택한 이름으로 저장합니다.
이 사양에서 Apigee API 프록시를 만들려면 더보기 메뉴에서 API 프록시 만들기를 클릭합니다. 이 과정에서 프록시 번들이 생성됩니다. 프록시의 왼쪽 메뉴 목록에 새 프록시가 표시됩니다. Cloud Code에서 프록시를 만드는 방법에 대한 자세한 내용은 Cloud Code에 통합된 API 프록시 만들기 둘러보기를 참조하세요.

효과적인 API 사양 프롬프트를 작성하는 방법

생성된 API 사양의 정확성과 적합성은 모델에 제공된 프롬프트에 크게 좌우됩니다.

다음은 좋은 프롬프트의 예시입니다.

고객이 신용카드, 체크카드 등의 다양한 결제 수단을 사용하여 주문 금액을 결제할 수 있는 API를 만들어줘.
API를 통해 커피 원두 구매 주문을 받고 싶어.
우리는 피자 회사이고 맞춤설정된 온라인 피자 배달 솔루션을 만들려고 해. 피자 주문을 접수할 수 있는 API를 만들어줘.
음식 배달 비즈니스용 API입니다. 고객은 피자, 버거 또는 샌드위치를 한 번에 주문할 수 있습니다. 이러한 각 음식 유형에는 고유한 스키마가 있습니다. 피자에는 토핑과 크기가 있습니다. 버거에는 토핑과 패티 유형이 있습니다. 샌드위치에는 빵 종류, 고기 종류, 야채, 치즈, 고객 요청사항이 있습니다.

이 예시에서는 덜 효과적인 프롬프트를 보여줍니다. 이렇게 구성된 프롬프트는 피하는 것이 좋습니다.

내 가게에 사용할 API를 만들어줘. 프롬프트에 포함된 정보가 너무 적어 모델이 완전하고 정확한 사양을 생성하기 어렵습니다.
주문 객체를 재사용하는 새로운 환불 API를 만들어줘. 새 API를 만들 때 Gemini Code Assist에서 어떤 객체를 재사용할지 지정할 필요가 없습니다. 재사용하기에 가장 적합한 객체를 Gemini Code Assist가 자동으로 감지합니다.

API 허브에 API 등록

API를 검토하고 완료한 후에는 이를 API 허브에 등록하여 개발자에게 제공할 수 있습니다.

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

Cloud Code에서 API 허브 API 업데이트

Cloud Code에서 API 허브 사양을 수정할 때 API 허브 사양의 새 버전을 저장할 수 있습니다.

사양을 새 버전으로 저장하려면 Swagger 패널에서 옵션 더보기... 버튼을 클릭하고 API 허브에 게시를 클릭합니다. 새 API 버전 ID를 제공합니다. Cloud Code의 API 허브 목록에 있는 해당 API의 버전 목록에 새 버전이 표시됩니다.

설정 파일을 사용하여 Gemini Code Assist 동작 제어

이 섹션에서는 설정 파일에서 Gemini Code Assist 사용 여부 및 제공 방식을 관리하는 방법을 설정합니다.

Gemini Code Assist 사용 중지 또는 사용 설정

Cloud Code에서 Apigee를 설정한 후(Cloud Code에서 Apigee 설정 참조) 설정 파일에 이 줄을 추가하여 모든 Gemini Code Assist 기능을 일시적으로 사용 중지할 수 있습니다.

"cloudcode.apigee.gemini.enable": false

줄을 삭제하거나 true(기본값)로 설정하여 Gemini Code Assist를 다시 사용 설정합니다.

사양 생성에 엔터프라이즈 컨텍스트 제어

OAS 생성에는 조직의 다른 API에서 가져온 스키마, 메타데이터, 보안 정의가 포함될 수 있습니다. 이 프로세스는 액세스 권한이 있는 API 허브 카탈로그에 포함된 객체 이름과 설명을 사용하여 비슷한 API를 찾습니다. API 허브 API의 배포 상태는 고려되지 않습니다.

엔터프라이즈 컨텍스트는 기본적으로 사용 설정되어 있습니다.

다음과 같은 작업을 할 수 있습니다.

엔터프라이즈 컨텍스트에서 Swagger 패널에 포함된 수정사항(있는 경우) 수를 확인합니다.
출력 패널에 포함된 수정사항을 확인합니다.

새로운 사양 생성에서 엔터프라이즈 컨텍스트를 사용 중지하려면 settings.json 파일에서 "cloudcode.apigee.gemini.enable": true 뒤에 다음 줄을 추가합니다.

"cloudcode.apigee.gemini.options": {
        "enterpriseContext": {
          "enabled": false,
          "includeMetadata": false,
          "includeSchema": false,
          "includeSecurity": false
        }
    }

각 항목의 의미는 다음과 같습니다.

enabled는 엔터프라이즈 컨텍스트가 전반적으로 사용 설정되는지 여부를 지정합니다. 엔터프라이즈 컨텍스트를 사용 중지하려면 false로 설정합니다.
includeMetadata는 메타데이터 컨텍스트 포함 여부를 제어합니다. 이 설정은 API 허브의 다른 API에 있는 메타데이터를 포함하거나 제외합니다. includeMetadata는 enabled가 true로 설정된 경우에만 적용됩니다.
includeSchema는 스키마 컨텍스트 포함 여부를 제어합니다. 이 설정은 API 허브의 다른 API에 있는 스키마 정보를 포함하거나 제외합니다. includeSchema는 enabled가 true로 설정된 경우에만 적용됩니다.
includeSecurity는 보안 관련 컨텍스트 포함 여부를 제어합니다. 이 설정은 API 허브의 다른 API에 있는 보안 정보를 포함하거나 제외합니다. includeSecurity는 enabled가 true로 설정된 경우에만 적용됩니다.

API 수정

Cloud Code를 사용하여 API 허브 카탈로그에 포함된 기존 API를 수정하려면 다음 안내를 따르세요. Cloud Code에서 변경한 내용을 API 허브에 다시 저장할 수 있습니다.

이 안내는 Apigee용 Gemini Code Assist 부가기능을 사용하지 않는 사용자를 대상으로 합니다. API를 설계하고 수정할 때 Gemini Code Assist에서 사용할 수 있는 추가 기능에 대한 자세한 내용은 Gemini Code Assist로 API 설계를 참조하세요.

API 사양을 수정하는 방법은 다음과 같습니다.

Cloud Code에서 선택한 프로젝트가 수정할 API가 포함된 API 허브 카탈로그가 있는 프로젝트인지 확인합니다.
왼쪽 탐색 메뉴에서 API 허브 트리를 펼칩니다.
목록에서 수정할 API 및 버전을 선택합니다.
수정 패널에서 사양을 수정합니다. Swagger 패널에서 API 작업을 볼 수도 있습니다.
필요한 경우 모의 서버를 사용하여 API를 테스트합니다.
Swagger 패널의 더보기 버튼을 사용하여 변경사항을 새 버전으로 저장한 후 API 허브에 게시합니다. 메시지가 표시되면 버전을 확인하거나 업데이트하고 변경사항을 API 허브에 다시 저장합니다. Cloud Code의 API 허브 목록에 있는 해당 API의 버전 목록에 새 버전이 표시됩니다.

모의 서버를 사용하여 API 테스트

로컬 모의 서버를 사용하여 API를 테스트할 수 있습니다. 로컬 모의 서버는 기본적으로 설치되며 사용 가능합니다.

로컬 모의 서버 사용

로컬 모의 서버는 이 API에 대한 요청을 수락하고 응답을 에뮬레이션합니다. 현재 사용자의 현재 세션 중에만 사용할 수 있습니다.

로컬 모의 서버를 사용하는 방법은 다음과 같습니다.

서버 드롭다운에서 로컬 모의 서버(개발 서버)를 선택합니다.
경로를 열고 사용해 보기를 클릭합니다.
요청 매개변수를 입력하고 실행을 클릭합니다.
프롬프트에서 curl을 사용하여 요청을 제출할 수도 있습니다. 서버 드롭다운에 있는 서버 주소와 포트를 사용합니다.