오류 수정을 위한 API 도우미 사용

온라인에서 편집하기

API Assistant의 사양 유효성 검사 오류 구성 요소를 사용하여 OpenAPI 3.0 사양을 분석하고 유효성 검사 오류에 대한 잠재적인 AI 수정 사항을 생성할 수 있습니다. 따라서 API 제공 속도가 빨라지고 유효성 검사 오류가 줄어듭니다.

API 어시스턴트는 IBM watsonx Granite LLM models 을 사용하여 API의 품질을 개선하고 소비자에게 더 빠르게 제공할 수 있도록 도와줍니다. API 어시스턴트를 활용하여 API 정의에 대한 AI 수정 사항을 빠르게 생성하세요.

API 어시스턴트를 사용하여 OpenAPI 3.0 유효성 검사 오류에 대한 AI 수정을 생성하는 방법

API 관리자에서 API 정의를 만들거나 편집하는 동안 API 도우미를 사용하세요. API 도우미는 OpenAPI 3.0 사양으로 API의 유효성을 검사하고 유효성 검사 오류에 대한 AI 수정을 제안합니다. 그런 다음 API 정의에 적용할 수정 사항을 선택할 수 있습니다.

  1. 로그인 IBM® API ConnectPremium subscription 를 사용합니다.
  2. API 관리자에서 편집하려는 OpenAPI 3.0 API를 엽니다.
  3. ‘디자인’ 탭에서 을 소스 보기 아이콘(앞쪽 슬래시로 둘러싸인 두 개의 꺾쇠 괄호를 포함하는 작은 회색 사각형)을 클릭합니다 클릭하여 소스 보기에서 작업하세요.
  4. 을 AI 아이콘(AI라는 글자와 검은색 화살표가 있는 작은 회색 사각형)을 클릭합니다 클릭하여 API 어시스턴트 패널을 엽니다.
  5. ‘사양 검증 오류’ 탭이 사양 유효성 검사 오류 탭 아이콘(작은 체크 표시가 있는 페이지의 윤곽선)을 클릭합니다 선택되어 있는지 확인하십시오.
  6. Validate를 클릭하여 OpenAPI 유효성 검사 사양을 통해 API를 실행합니다.
  7. API에서 유효성 검사 오류가 감지되고 API 도우미로 수정할 수 있는 경우 제안된 수정 사항이 표시됩니다.
    주: 모든 유효성 검사 오류 또는 경고에 AI 수정이 적용될 수 있는 것은 아닙니다. 예를 들어 x-ibm 관련 문제에 대한 AI 수정 사항은 반환되지 않습니다.
  8. 각 제안에 대해 수정를 클릭하여 수정 사항을 API에 통합하거나 무시를 클릭하여 수정 사항을 무시할 수 있습니다.

    모든 제안을 빠르게 수락하려면 수정 사항 적용를 클릭하세요.

  9. 저장을 클릭하여 업데이트된 API 정의를 저장합니다.

예시: 샘플 개선하기 테스트 오류 API

이 예에서는 오류 API 테스트를 사용하여 OpenAPI 사양으로 API를 검증하고, 제안된 AI 수정 사항을 검토한 후 해당 수정 사항을 적용하는 흐름을 보여드리고 있습니다. 자체 API를 사용하여 단계를 수행할 수 있습니다.

  1. 로그인 API ConnectPremium subscription 를 사용합니다.

  2. API Manager 에서 [개발 ] 개발 아이콘(흰색 연필 윤곽선이 있는 작은 검은색 사각형)을 클릭합니다 을 클릭하여 API 개발 페이지를 연 다음, API 탭이 선택되어 있는지 확인하여 자신의 API를 확인할 수 있도록 하세요.
    개발 페이지를 엽니다

  3. OpenAPI3.0 (REST) 유형 의 API를 선택한 다음, 제 목을 클릭하여 편집합니다.
    OpenAPI 3.0 API를 편집합니다

  4. 디자인 페이지가 양식 보기에서 열립니다. 소스 보기에서 작업하려면 여기를 소스 보기 아이콘(앞쪽 슬래시로 둘러싸인 두 개의 꺾쇠 괄호를 포함하는 작은 회색 사각형)을 클릭합니다 클릭하세요.

    API의 소스 코드를 볼 수 있으면 API 어시스턴트를 더 쉽게 사용할 수 있습니다.


    소스 보기 아이콘 주위에 하이라이트가 표시된 양식 보기의 API 디자인 페이지 스크린샷입니다.

  5. 을 AI 아이콘(AI라는 글자와 검은색 화살표가 있는 작은 회색 사각형)을 클릭합니다 클릭하여 API 어시스턴트 패널을 엽니다. ‘사양 검증 오류’ 탭이 선택되어 있는지 확인하십시오.
    사양 유효성 검사 오류 탭이 열려 있는 API 지원 패널을 보여주는 스크린샷입니다.

  6. ‘사양 유효성 검사 오류’ 탭에서 를 AI 설명 아이콘(AI라는 글자가 포함된 작은 검은색 사각형의 윤곽선)을 클릭합니다 클릭하면, API Assistant가 AI를 활용하여 OpenAPI 구문 오류를 신속하게 해결하는 방법에 대해 자세히 알아볼 수 있습니다.
    AI 사양 유효성 검사 설명 팝업을 보여주는 스크린샷입니다.

    팝업을 닫으려면 다시 AI 설명 아이콘(AI라는 글자가 포함된 작은 검은색 사각형의 윤곽선)을 클릭합니다 클릭하세요.

  7. 이제 Validate를 클릭하여 OpenAPI 3.0 사양으로 API를 검증하고 AI 수정 사항이 확인되는지 확인합니다.

    오류가 발견되고 AI가 수정할 수 있는 경우 API 도우미는 제안된 수정 사항 목록을 반환합니다.


    사양 유효성 검사 오류에 대한 AI 권장 사항 스크린샷.

    다음과 같은 디스플레이 변경 사항에 주목하세요:

    • 사양 유효성 검사 오류 탭에는 API 도우미가 발견한 사양 오류의 목록이 표시됩니다. 발견된 총 오류 수는 패널의 시작 부분에 표시됩니다.
    • API 어시스턴트 패널이 열려 있는 동안에는 실수로 업데이트되는 것을 방지하기 위해 API 소스 코드가 읽기 전용 모드로 설정됩니다. 패널을 닫으면 코드를 다시 편집할 수 있게 됩니다.
    • 오류에 대해 제안된 AI 수정안을 사용할 수 있는 경우, 수정안은 사양 유효성 검사 오류 탭에 무시 및 수정 옵션과 함께 표시됩니다. 제안된 수정 사항은 소스 코드에도 원래 오류 바로 아래에 표시됩니다.
    • 해당 오류에 AI 수정 기능이 없는 경우, 오류는 유효성 검사 오류 아이콘과 함께 유효성 검사 오류 아이콘은 흰색 백슬래시가 포함된 작은 빨간색 점입니다표시됩니다.
  8. 제안된 수정 사항을 수락하거나 거부할 준비가 되면 다음 옵션을 사용할 수 있습니다:
    • 제안된 모든 수정 사항을 빠르게 수락하려면 수정 사항 적용를 클릭하세요.
    • 개별 수정 사항을 수락하거나 거부하려면 각 제안 사항에서 수정 또는 무시를 클릭합니다.
    • 검증을 다시 실행하려면 을 클릭하여 최신 사양 오류 및 AI 모든 아이콘 다시 생성 수정 사항을 확인하세요.

    제안된 수정 사항을 살펴볼 때 다음 동작에 유의하세요:

    • 적용한 모든 수정 사항은 API 정의에 추가되지만 API 페이지 헤더에서 저장을 클릭할 때까지 정의 자체는 저장되지 않습니다.
    • 저장하기 전에 API를 계속 편집하고 유효성 검사를 다시 실행하여 제안된 수정 사항을 다시 생성할 수 있습니다.
    • 저장을 클릭하면 자신의 변경 사항과 적용된 모든 수정 사항이 저장되지만, 적용하지 않은 제안은 모두 손실됩니다.
    • 수정 사항을 적용하기 전에 API 디자인 페이지에서 다른 곳으로 이동하면 해당 수정 사항이 손실됩니다.
  9. API 어시스턴트 패널을 닫으려면 을 클릭하세요 API 보조 패널 닫기 아이콘.

  10. 양식 보기로 돌아가려면 을 클릭하세요 양식 보기 아이콘.

    샘플 API에서 제안된 AI 수정 사항이 적용되었으며 이제 사양 상태가 녹색으로 표시된 것을 확인할 수 있습니다.


    모든 오류가 수정된 샘플 API의 스크린샷입니다.

  11. 저장을 클릭하여 업데이트된 API 정의를 저장하는 것을 잊지 마세요.