Khám phá dịch vụ Quản lý API

Đã hoàn thành

Quản lý API cung cấp chức năng cốt lõi để đảm bảo một chương trình API thành công thông qua tương tác với nhà phát triển, thông tin chuyên sâu về doanh nghiệp, phân tích, bảo mật và bảo vệ. Mỗi API bao gồm một hoặc nhiều thao tác và mỗi API có thể được thêm vào một hoặc nhiều sản phẩm. Để sử dụng API, các nhà phát triển đăng ký một sản phẩm có chứa API đó và sau đó họ có thể gọi hoạt động của API, tuân theo bất kỳ chính sách sử dụng nào.

Cấu phần Quản lý API

Azure API Management được tạo thành từ một API gateway, một máy bay quản lý và cổng thông tin nhà phát triển của. Các cấu phần này được lưu trữ trên Azure và được quản lý hoàn toàn theo mặc định. Quản lý API có sẵn ở nhiều cấp khác khác nhau về công suất và tính năng.

  • Điểm API là điểm cuối:

    • Chấp nhận các cuộc gọi API và định tuyến chúng đến các phụ trợ thích hợp
    • Xác minh khóa API và thông tin xác thực khác được trình bày theo yêu cầu
    • Thực thi hạn ngạch sử dụng và giới hạn tỷ lệ
    • Chuyển đổi các yêu cầu và phản hồi được chỉ định trong câu lệnh chính sách
    • Lưu trữ phản hồi để cải thiện độ trễ phản hồi và giảm thiểu tải trên dịch vụ phụ trợ
    • Phát ra nhật ký, số liệu và theo dõi để giám sát, báo cáo và khắc phục sự cố
  • Máy bay quản lý là giao diện quản trị nơi bạn thiết lập chương trình API của mình. Sử dụng tính năng này để:

    • Cung cấp và đặt cấu hình cài đặt dịch vụ Quản lý API
    • Xác định hoặc nhập sơ đồ API
    • Đóng gói API vào sản phẩm
    • Thiết lập các chính sách như hạn ngạch hoặc chuyển đổi trên API
    • Nhận thông tin chuyên sâu từ phân tích
    • Quản lý người dùng
  • Cổng thông dành cho Nhà phát là một website được tạo tự động, hoàn toàn có thể tùy chỉnh với tài liệu về API của bạn. Sử dụng cổng thông tin dành cho nhà phát triển, nhà phát triển có thể:

    • Đọc tài liệu API
    • Gọi API qua bảng điều khiển tương tác
    • Tạo tài khoản và đăng ký nhận khóa API
    • Truy nhập phân tích về mức sử dụng riêng của họ
    • Tải xuống định nghĩa API
    • Quản lý khóa API

Sản phẩm

Sản phẩm là cách các API được hiển thị cho các nhà phát triển. Các sản phẩm trong Quản lý API có một hoặc nhiều API và được đặt cấu hình với tiêu đề, mô tả và điều khoản sử dụng. Sản phẩm có thể được mở bảo được bảo vệ. Sản phẩm được bảo vệ phải được đăng ký trước khi có thể sử dụng, trong khi các sản phẩm đang mở có thể được sử dụng mà không cần đăng ký. Phê duyệt đăng ký được đặt cấu hình ở cấp sản phẩm và có thể yêu cầu người quản trị phê duyệt hoặc được tự động phê duyệt.

Nhóm

Nhóm được sử dụng để quản lý khả năng hiển thị sản phẩm cho các nhà phát triển. Quản lý API có các nhóm hệ thống không thể thay đổi sau đây:

  • trị viên - Quản lý các phiên bản dịch vụ Quản lý API và tạo API, hoạt động và sản phẩm được nhà phát triển sử dụng. Người quản trị đăng ký Azure là thành viên của nhóm này.
  • Developers - Người dùng cổng thông tin nhà phát triển được xác thực xây dựng các ứng dụng sử dụng API của bạn. Nhà phát triển được cấp quyền truy cập vào cổng thông tin dành cho nhà phát triển và xây dựng các ứng dụng gọi hoạt động của API.
  • khách - Người dùng cổng thông tin nhà phát triển chưa xác thực. Họ có thể được cấp một số quyền truy cập chỉ đọc, chẳng hạn như khả năng xem API nhưng không thể gọi chúng.

Ngoài các nhóm hệ thống này, người quản trị có thể tạo nhóm tùy chỉnh hoặc sử dụng nhóm bên ngoài trong đối tượng thuê Microsoft Entra liên kết.

Phát triển

Nhà phát triển đại diện cho tài khoản người dùng trong phiên bản dịch vụ Quản lý API. Nhà phát triển có thể được tạo hoặc mời tham gia bởi người quản trị hoặc họ có thể đăng ký từ cổng thông tin Nhà phát triển. Mỗi nhà phát triển là thành viên của một hoặc nhiều nhóm và có thể đăng ký các sản phẩm cấp khả năng hiển thị cho các nhóm đó.

Chính sách

Chính sách là tập hợp các câu lệnh được thực hiện tuần tự trên yêu cầu hoặc phản hồi của API. Các câu lệnh phổ biến bao gồm chuyển đổi định dạng từ XML sang JSON và giới hạn tốc độ cuộc gọi để hạn chế số lượng cuộc gọi đến từ nhà phát triển và nhiều chính sách khác sẵn dùng.

Biểu thức chính sách có thể được sử dụng làm giá trị thuộc tính hoặc giá trị văn bản trong bất kỳ chính sách quản lý API nào, trừ khi chính sách chỉ định khác. Một số chính sách như Dòng điều khiển và Đặt chính sách biến được dựa trên biểu thức chính sách.

Các chính sách có thể được áp dụng ở các phạm vi khác nhau, tùy thuộc vào nhu cầu của bạn: toàn cầu (tất cả API), sản phẩm, API cụ thể hoặc thao tác API.