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

View API Settings

Để xem cài đặt API, hãy điều hướng đến trang Backend Servers. Tìm API bạn cần. Nhấp vào API để mở tóm tắt chi tiết.

mẹo

Sử dụng các công cụ Tìm kiếm và Lọc để nhanh chóng tìm API bạn cần.

Tổng quan​

Tab Tổng quan cung cấp các chi tiết chính về API đã chọn, bao gồm cấu hình và dữ liệu của nó.

Thông tin API​

Phần này chứa thông tin chung, xác định và mô tả API.

  • Version: Chỉ ra phiên bản phát hành cụ thể của API, theo quy tắc phiên bản ngữ nghĩa (ví dụ: v1.0.0). Điều này giúp theo dõi các bản cập nhật và thay đổi theo thời gian.
  • Backend System Name: Mã định danh nội bộ duy nhất hoặc tên mã cho API trong hệ thống (ví dụ: petstorev3).
  • Description: Chi tiết giải thích mục đích của API, thông số kỹ thuật mà nó dựa vào (như OpenAPI 3.0), cách thiết kế của nó và các mục tiêu của nó.
  • Label: Các cặp khóa-giá trị được sử dụng để phân loại, lọc và tổ chức các API. Chúng cung cấp một cách linh hoạt để thêm dữ liệu tùy chỉnh. Một API có thể có nhiều nhãn cho các mục đích khác nhau.

Thông tin Backend​

Phần này chi tiết thông tin endpoint để tương tác với API.

  • Backend ID: Một chuỗi alphanumeric duy nhất do hệ thống tạo ra xác định dịch vụ backend cụ thể cung cấp API (ví dụ: 68a67d3008c05608c7f1c734).
  • Domain: Địa chỉ web chính nơi API được lưu trữ. Đây là URL cơ bản cho tất cả các cuộc gọi API (ví dụ: https://petstore3.swagger.io/api/v3).
  • BasePath: Phân đoạn đường dẫn được thêm vào miền để tạo ra URL cơ bản đầy đủ cho các điểm cuối API. Giá trị / cho biết rằng các điểm cuối được truy cập trực tiếp từ gốc miền.

Thông tin xác thực​

Phần này xác định các yêu cầu bảo mật để truy cập API.

  • Authentication Type: Định nghĩa phương pháp được sử dụng để bảo mật API. Ví dụ, giá trị là None, có nghĩa là API là công khai và không yêu cầu bất kỳ thông tin xác thực hoặc mã thông báo nào để truy cập.

Thông tin meta​

Phần này cung cấp thông tin kiểm toán và theo dõi về vòng đời của API trong hệ thống.

  • Date of Creation: Ngày và giờ chính xác mà API được đăng ký lần đầu tiên trong hệ thống.
  • Constructor: Tên người dùng hoặc ID của cá nhân đã tạo ra API.
  • Date of Modification: Cho biết khi nào cấu hình của API được cập nhật lần cuối.
  • Modifier: Tên người dùng hoặc ID của cá nhân đã thực hiện các thay đổi gần đây nhất.

Xem trước API​

Tab Xem trước API cung cấp một giao diện người dùng tương tác, thường được hỗ trợ bởi các công cụ như Swagger UI, cho phép bạn khám phá và thử nghiệm các điểm cuối của API trực tiếp từ trình duyệt của bạn.

Đặc tả API​

Trong phần này, bạn có thể tìm thấy các chi tiết nhận dạng chính của đặc tả API.

  • API Title: Tên chính thức của API.
  • Version Badges: Các thẻ nhỏ chỉ ra số phiên bản của API (ví dụ: 1.0.27) và thông số kỹ thuật mà nó tuân theo (ví dụ: OAS 3.1 cho OpenAPI Specification 3.0).
  • Description: Một tóm tắt dễ đọc về API.

Xác thực API​

Trong phần này, bạn có thể tìm thấy các yếu tố cho phép bạn cấu hình và xác thực các yêu cầu thử nghiệm của mình.

  • Servers: Một menu thả xuống để chọn môi trường máy chủ mục tiêu cho các cuộc gọi API của bạn. Điều này cho phép bạn chuyển đổi giữa các URL cơ sở khác nhau, chẳng hạn như môi trường phát triển, staging hoặc sản xuất.
  • Authorize: Một nút mở hộp thoại Các quyền xác thực có sẵn nơi bạn có thể nhập thông tin xác thực của mình, như khóa API hoặc mã thông báo OAuth2. Khi đã thiết lập, các thông tin xác thực này sẽ tự động được bao gồm trong bất kỳ yêu cầu thử nghiệm nào bạn thực hiện từ trang này.

Các API endpoint​

Đây là phần cốt lõi của API Preview, nơi tất cả các hoạt động có sẵn được liệt kê.

  • Endpoint Groups: Các điểm cuối được tổ chức thành các nhóm logic dựa trên một "thẻ," thường tương ứng với một tài nguyên cụ thể. Trong ví dụ này, tất cả các điểm cuối được nhóm lại dưới thẻ pet.
  • Endpoint Details: Mỗi dòng đại diện cho một hoạt động duy nhất bạn có thể thực hiện và bao gồm:
    • HTTP Method: Loại hành động, chẳng hạn như PUT (cập nhật), POST (tạo), hoặc GET (đọc).
    • Path: Đường dẫn URL cụ thể cho điểm cuối (ví dụ: /pet, /pet/findByStatus).
  • Description: Tóm tắt ngắn gọn về chức năng của điểm cuối.
    • Authentication Indicator: Biểu tượng khóa cho biết liệu một điểm cuối có yêu cầu xác thực hay không. Biểu tượng mở có nghĩa là nó mở, trong khi biểu tượng khóa có nghĩa là bạn phải cung cấp thông tin xác thực bằng cách sử dụng nút Ủy quyền.

Bằng cách nhấp vào bất kỳ hàng điểm cuối nào, bạn có thể mở rộng nó để xem thông tin chi tiết, bao gồm các tham số cần thiết, cấu trúc thân yêu cầu và các phản hồi có thể, và thậm chí thực hiện một cuộc gọi API trực tiếp:

Schemas​

Nằm ở cuối trang xem trước, phần Schemas định nghĩa cấu trúc của tất cả các mô hình dữ liệu được sử dụng trong các yêu cầu và phản hồi của API.

  • Danh sách Schema: Khu vực này liệt kê tất cả các đối tượng dữ liệu đã được định nghĩa, chẳng hạn như Pet, Order, và User.
  • Xem Chi tiết: Bạn có thể nhấp vào bất kỳ tên schema nào để mở rộng nó để xem chi tiết về các thuộc tính của đối tượng, bao gồm tên trường (ví dụ: id, name), kiểu dữ liệu của chúng (integer, string), và ví dụ.