Chuyển tới nội dung chính

Register a New Backend API

Trong AI Agent Studio, bạn có thể đăng ký các thông số kỹ thuật OpenAPI để tự động tạo ra các backend.

Để đăng ký một Backend API mới, hãy điều hướng đến tab Backend Servers trong bảng điều khiển Agent Studio của bạn và làm theo các bước dưới đây:

  1. Tìm và nhấp vào nút Register Backend ở góc trên bên phải của trang để bắt đầu quá trình đăng ký.

  1. Điền thông tin chi tiết về backend API với các trường sau trong mẫu đăng ký:

  • Domain: Nhập miền gốc hoặc URL cơ sở của máy chủ backend của bạn (ví dụ: https://petstore3.swagger.io).
  • BasePath: Chỉ định đường dẫn cơ sở cho các điểm cuối API của bạn (ví dụ: /api/v3).
  • Backend Name: Chọn một tên duy nhất cho backend này (ví dụ: PetstoreV3). Điều này giúp bạn xác định backend trong danh sách máy chủ của bạn.
  • Version: Chỉ định phiên bản API (ví dụ: v1.0.0).
  • Open API Specification: Bạn có thể cung cấp thông số kỹ thuật API của mình theo một trong ba cách:
    • From URL: Dán liên kết đến thông số kỹ thuật OpenAPI/Swagger của bạn (ví dụ: https://petstore3.swagger.io/openapi.json)
    • Paste JSON: Dán văn bản JSON của thông số kỹ thuật OpenAPI của bạn.
    • Upload File: Tải lên một tệp Swagger/OpenAPI (JSON hoặc YAML).
  • Description: Viết một mô tả ngắn giải thích mục đích và tính năng của API.
  • Authentication Type: Chọn loại xác thực yêu cầu bởi máy chủ backend này:
    • Basic: Cần tên người dùng và mật khẩu để xác thực.
    • Bearer: Cần một mã thông báo bearer (chẳng hạn như JWT) trong tiêu đề Authorization.
  • API Key: Cần gửi một khóa API cụ thể, thường là trong tiêu đề yêu cầu hoặc tham số truy vấn.
    • None: API là công khai và không yêu cầu thông tin xác thực để truy cập.
  • Label: Thêm nhiều nhãn cần thiết cho mục đích lọc. Nhãn sau đó sẽ được hiển thị trên mỗi thẻ trong danh sách Máy chủ Backend trên màn hình.
  1. Sau khi điền tất cả các trường và xác nhận thông tin là chính xác, nhấp vào nút Save. Nếu bạn muốn hủy, nhấp vào nút Cancel.

Sau khi lưu đăng ký thành công, API backend mới của bạn sẽ xuất hiện trong danh sách Máy chủ Backend. Bạn có thể chọn Sort by "Created At" để tìm API backend mới tạo của bạn và xem lại chi tiết để đảm bảo mọi thứ là chính xác:

mẹo
  • Kiểm tra lại thông số kỹ thuật OpenAPI để đảm bảo tính chính xác.
  • Sử dụng tên và mô tả rõ ràng để dễ dàng nhận diện.
  • Đảm bảo loại xác thực phù hợp với yêu cầu bảo mật backend của bạn.