본문으로 건너뛰기

Register a New Backend API

AI Agent Studio 내에서 OpenAPI 사양을 등록하여 자동으로 백엔드를 생성할 수 있습니다.

새로운 백엔드 API를 등록하려면, Agent Studio 대시보드의 Backend Servers 탭으로 이동하고 아래 단계를 따르세요:

  1. 페이지 오른쪽 상단에 있는 Register Backend 버튼을 찾아 클릭하여 등록 프로세스를 시작합니다.

  1. 등록 양식의 다음 필드를 사용하여 백엔드 API 세부정보를 입력합니다:

  • Domain: 백엔드 서버의 루트 도메인 또는 기본 URL을 입력합니다 (예: https://petstore3.swagger.io).
  • BasePath: API 엔드포인트의 기본 경로를 지정합니다 (예: /api/v3).
  • Backend Name: 이 백엔드의 고유한 이름을 선택합니다 (예: PetstoreV3). 이는 서버 목록에서 백엔드를 식별하는 데 도움이 됩니다.
  • Version: API 버전을 지정합니다 (예: v1.0.0).
  • Open API Specification: API 사양을 다음 세 가지 방법 중 하나로 제공할 수 있습니다:
    • From URL: OpenAPI/Swagger 사양의 링크를 붙여넣습니다 (예: https://petstore3.swagger.io/openapi.json)
    • Paste JSON: OpenAPI 사양의 JSON 텍스트를 붙여넣습니다.
    • Upload File: Swagger/OpenAPI 파일을 업로드합니다 (JSON 또는 YAML).
  • Description: API의 목적과 기능을 설명하는 짧은 설명을 작성합니다.
  • Authentication Type: 이 백엔드 서버에서 요구하는 인증 유형을 선택합니다:
    • Basic: 인증을 위해 사용자 이름과 비밀번호가 필요합니다.
    • Bearer: Authorization 헤더에 베어러 토큰(예: JWT)이 필요합니다.
  • API Key: 특정 API 키를 전송해야 하며, 일반적으로 요청 헤더 또는 쿼리 매개변수에 포함됩니다.
    • None: API는 공개되어 있으며 접근을 위한 인증 자격 증명이 필요하지 않습니다.
  • Label: 필터링 목적을 위해 필요한 만큼의 레이블을 추가하세요. 레이블은 화면의 백엔드 서버 목록에 있는 각 카드에 표시됩니다.
  1. 모든 필드를 작성하고 정보가 정확한지 확인한 후, Save 버튼을 클릭하세요. 취소하려면 Cancel 버튼을 클릭하세요.

등록이 성공적으로 저장되면, 새 백엔드 API가 백엔드 서버 목록에 나타납니다. Sort by "Created At"를 선택하여 새로 생성된 백엔드 API를 찾고 세부 정보를 검토하여 모든 것이 정확한지 확인할 수 있습니다:

팁
  • OpenAPI 사양의 정확성을 다시 확인하세요.
  • 쉽게 식별할 수 있도록 명확한 이름과 설명을 사용하세요.
  • 인증 유형이 백엔드 보안 요구 사항과 일치하는지 확인하세요.