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

Change API Settings

Bạn có thể chỉnh sửa cấu hình của một API hiện có để cập nhật các chi tiết cốt lõi, nguồn tài liệu, nhãn và cài đặt bảo mật cho API của bạn.

Nếu bạn đang sử dụng chế độ Xem Lưới, hãy nhấp vào menu ba chấm để mở các mục hành động, sau đó nhấp vào nút chỉnh sửa (biểu tượng bút chì) để mở biểu mẫu Chi tiết API.

Nếu bạn đang sử dụng chế độ Xem Danh sách, hãy đến cột Hành động và nhấp vào nút chỉnh sửa (biểu tượng bút chì) để mở biểu mẫu Chi tiết API.

Nhấp vào nút chỉnh sửa sẽ mở biểu mẫu Chỉnh sửa Chi tiết API. Điền vào các thay đổi của bạn khi cần thiết.

  • Backend Name: (trường bắt buộc) Một tên hiển thị thân thiện với người dùng cho API (ví dụ: PetstoreV3).

  • Backend System Name: (trường tự động điền) Định danh nội bộ duy nhất cho API (ví dụ: petstorev3). Tên này thường được sử dụng trong các tham chiếu hệ thống và có thể có các hạn chế về ký tự.

  • Version: (trường bắt buộc) Số phiên bản của API của bạn (ví dụ: v1.0.0). Nên tuân theo các thực tiễn phiên bản ngữ nghĩa.

  • Domain: (trường bắt buộc) Miền cơ sở nơi API của bạn được lưu trữ (ví dụ: https://petstore3.swagger.io/api/v3).

  • BasePath: (trường bắt buộc) Đường dẫn phụ được thêm vào Miền để tạo thành URL cơ sở hoàn chỉnh cho tất cả các điểm cuối (ví dụ: /).

  • Open API Specification: (trường bắt buộc) Cung cấp tài liệu định nghĩa của API, mô tả tất cả các điểm cuối và hoạt động của nó. Bạn phải chỉ định nguồn của định nghĩa này theo một trong ba cách:

    • From URL: Cung cấp một liên kết web trực tiếp đến tệp định nghĩa OpenAPI (ví dụ: tệp .json hoặc .yaml).

  • Paste JSON: Dán nội dung của định nghĩa OpenAPI JSON trực tiếp vào một trường văn bản.

  • Upload File: Tải lên một tệp định nghĩa OpenAPI từ máy tính của bạn.

  • Description: (trường bắt buộc) Một trường văn bản để cung cấp mô tả chi tiết, dễ đọc về mục đích và chức năng của API. Thông tin này được hiển thị trên màn hình Tổng quan API và giúp người dùng khác hiểu cách sử dụng API.

  • Authentication Type: (trường bắt buộc) Chọn phương thức bảo mật cần thiết để khách hàng truy cập API.

    • Basic: Cần có tên người dùng và mật khẩu để xác thực.
    • Bearer: Cần có một mã thông báo bearer (chẳng hạn như JWT) trong tiêu đề Authorization.
    • API Key: Cần có một khóa API cụ thể được gửi, 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: Phần này cho phép bạn quản lý các thẻ, là các cặp khóa-giá trị được sử dụng để tổ chức, lọc hoặc thêm siêu dữ liệu tùy chỉnh vào API.

    • Thêm một Nhãn: Nhấp vào biểu tượng cộng (+) để thêm một nhãn mới.
    • Khóa / Giá trị: Mỗi nhãn yêu cầu cả Khóa (định danh, ví dụ: môi trường) và Giá trị (dữ liệu, ví dụ: demo). Như đã chỉ ra bởi các thông báo lỗi, cả hai trường đều là bắt buộc khi một hàng nhãn được thêm vào.
    • Xóa một Nhãn: Nhấp vào biểu tượng thùng rác để xóa hàng nhãn tương ứng. Sau khi xác thực thông tin bạn đã nhập, hãy nhấp vào nút Save để áp dụng cấu hình mới cho API. Nếu bạn muốn bỏ qua tất cả các thay đổi đã thực hiện trên màn hình này, hãy nhấp vào nút Cancel để đóng biểu mẫu.