Luồng dùng chung có thể tái sử dụng

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến Tài liệu về Apigee X. thông tin

Bạn có thể kết hợp các chính sách và tài nguyên vào một quy trình dùng chung mà bạn có thể sử dụng nhiều proxy API và thậm chí từ các luồng dùng chung khác. Mặc dù giống như một proxy, nhưng luồng được chia sẻ không có điểm cuối. Bạn chỉ có thể sử dụng lớp này từ một proxy API hoặc quy trình dùng chung trong cùng một proxy tổ chức dưới dạng quy trình chung.

Bằng cách nắm bắt chức năng tập trung tại một nơi và hữu ích ở nhiều nơi, một quy trình chung sẽ giúp bạn đảm bảo tính nhất quán, rút ngắn thời gian phát triển và quản lý mã dễ dàng hơn.

Video sau đây minh hoạ cách tạo và theo dõi một luồng dùng chung trong giao diện người dùng Edge.

Video dài 5 phút sau đây minh hoạ cách tạo và theo dõi một luồng được chia sẻ trong phiên bản cũ Giao diện người dùng Edge (Edge chỉ dành cho Đám mây riêng tư).

Bạn có thể gọi một quy trình chia sẻ bằng chính sách FlowAnnotation. Ngoài ra, bằng cách đính kèm luồng được chia sẻ vào hook flow, bạn có thể thực thi flow chia sẻ trước khi có proxy hoặc yêu cầu mục tiêu, hoặc sau phản hồi proxy hoặc mục tiêu.

Để tham khảo chính sách FlowAnnotation, hãy xem chính sách về FlowAnnotation. Tìm hiểu thêm về flow hook, hãy xem phần Đính kèm flow dùng chung bằng flow hook.

Ví dụ: giả sử bạn có các khu vực chức năng được sử dụng ở nhiều nơi hoặc phải được chuẩn hoá trên các API trong tổ chức của bạn. Bạn có thể có một quy trình chung cho mỗi chủ đề danh mục, bao gồm:

  • bảo mật, bằng mã uỷ quyền dùng phương thức xác minh khoá API và OAuth cũng như mã bảo vệ chống mối đe doạ.
  • ghi nhật ký, để tạo các thông báo lỗi tiêu chuẩn.
  • dàn xếp để chuyển đổi giữa các định dạng thông báo XML và JSON.

Trong hình minh hoạ sau, hai proxy API gọi ra (với chính sách FlowAnnotation) đến một luồng chung để xác thực các yêu cầu đến của người dùng. AuthSharedFlow đã được triển khai riêng biệt với tổ chức trước các proxy để có thể hỗ trợ các yêu cầu từ proxy. Một quy trình dùng chung có thể do một nhóm phụ trách nhiều công ty lớn phát triển và quản lý chính sách, sau đó được sử dụng trong proxy bởi các nhóm chuyên môn xây dựng các ứng dụng chuyên biệt hơn.

Phát triển một quy trình dùng chung

Khi phát triển một luồng dùng chung, bạn phải luôn kiểm thử luồng đó với các lệnh gọi được gửi đến một proxy API. Trong nói cách khác, bạn không thể gửi trực tiếp các yêu cầu đến một flow được chia sẻ như với proxy API. Thay vào đó, bạn gửi yêu cầu đến một proxy API, do đó, gọi đến quy trình được chia sẻ.

Dưới đây là các bước cấp cao để phát triển luồng dùng chung:

  1. Tìm hiểu nhóm tính năng dùng chung sẽ là gì.

    Ví dụ: bạn có thể muốn kết hợp các tính năng quản lý lưu lượng truy cập, bao gồm cả chặn mốc tăng đột biến về lưu lượng truy cập. Bằng cách đó, bạn có thể quản lý cấu hình ngoài quy trình làm việc của triển khai logic ngành nghề kinh doanh.

  2. Xây dựng quy trình dùng chung bằng cách triển khai các chính sách và tài nguyên hỗ trợ, giống như bạn khi phát triển proxy API.

    Quy trình dùng chung là một chuỗi các bước có điều kiện. Vì vậy, việc phát triển một chiến dịch cũng giống như phát triển một Proxy API. Bạn có thể bao gồm các chính sách và tài nguyên mà bạn có thể đưa vào proxy.

    Ví dụ: trong quá trình hỗ trợ quản lý lưu lượng truy cập, bạn có thể triển khai một Spike Chính sách bắt giữ chỉ cho phép 30 yêu cầu mỗi giây, như trong ví dụ sau:

    <SpikeArrest async="false" continueOnError="false" enabled="true" name="Spike-Arrest">
    <DisplayName>Spike Arrest</DisplayName>
    <Properties/>
    <Identifier ref="request.header.some-header-name"/>
    <MessageWeight ref="request.header.weight"/>
    <Rate>30ps</Rate>
</SpikeArrest>

    Sau đó, đối với một quy trình chung để quản lý lưu lượng truy cập, bạn có thể đính kèm Chính sách về việc giam giữ tăng đột biến dưới dạng một bước. Chính sách này sẽ thực thi cho mọi proxy API gọi luồng được chia sẻ.

    <SharedFlow name="default">
    <Step>
        <Name>Spike-Arrest</Name>
    </Step>
</SharedFlow>

    Để biết thông tin về cách bắt đầu quy trình được chia sẻ trong bảng điều khiển quản lý, hãy xem Tạo luồng dùng chung trong giao diện người dùng Edge.

    Giống như proxy API, bạn có thể nhập tệp zip chứa nguồn luồng được chia sẻ của mình cấu phần phần mềm (xem Nhập Proxy API để biết thêm thông tin về cách nhập proxy). Sau đây minh hoạ cách nhập quy trình chung với API Quản lý:

    curl -X POST -F "file=@/path/to/zip/file.zip" \ 'https://api.enterprise.apigee.com/v1/o/{org_name}/sharedflows?action=import&name=shared-flow-name' \
-u email:password
  3. Triển khai luồng dùng chung cho môi trường trước khi triển khai proxy hoặc luồng dùng chung sẽ tiêu thụ dữ liệu đó. Bạn triển khai quy trình dùng chung giống như cách triển khai proxy API. (Đối với thông tin khác, hãy xem phần Triển khai tổng quan.)

    Một flow dùng chung phải nằm trong cùng một tổ chức và được triển khai cho cùng một môi trường với API proxy và các luồng dùng chung khác sử dụng luồng dữ liệu đó. Triển khai luồng được chia sẻ trước proxy giúp bạn có thể giải quyết phần phụ thuộc của proxy vào luồng dùng chung tại thời điểm triển khai.

    Bạn có thể triển khai quy trình dùng chung bằng lệnh gọi API quản lý, chẳng hạn như sau:

    curl -X POST --header "Content-Type: application/octet-stream" \
https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments \
-u email:password

    Bạn cũng có thể thay thế một quy trình dùng chung đang được triển khai mà không bị ngừng hoạt động. (Điều này giống như Proxy API. Xem phần Triển khai proxy API bằng Management API để tìm hiểu thêm). Dưới đây là biểu mẫu yêu cầu sử dụng API quản lý:

    curl -X POST --header "Content-Type:application/x-www-form-urlencoded" \
https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/sharedflows/{shared_flow_name}/revisions/{revision_number}/deployments?"override=true" \
-u email:password
  4. Phát triển proxy API đang dùng để có thể gọi quy trình được chia sẻ như một phần của riêng mình luồng.

    Từ một proxy API, bạn sẽ gọi đến một quy trình chia sẻ bằng chính sách về FlowAnnotation. (Bạn có thể đồng thời đính kèm flow chia sẻ vào proxy bằng hook flow, như mô tả trong bài viết Đính kèm flow chia sẻ bằng hook flow.) Để xem hướng dẫn giới thiệu về cách tạo proxy API, hãy xem Tạo proxy API đầu tiên.

    Để sử dụng luồng được chia sẻ, bạn thêm chính sách FlowAnnotation vào proxy hoặc luồng chia sẻ sẽ sử dụng dữ liệu đó. Giống như chính sách Chú thích dịch vụ mà bạn gọi cho một dịch vụ khác, FlowAnnotation gọi đến quy trình được chia sẻ. Proxy API đang sử dụng phải được triển khai sau quy trình chung và chuyển đến cùng một môi trường với quy trình chung. Chiến lược phát hành đĩa đơn bạn phải áp dụng quy trình chung khi muốn thử nghiệm lệnh gọi đến luồng này bằng chính sách FlowAnnotation.

    Trong mã sau, chính sách FlowAnnotation gọi một quy trình được chia sẻ có tên là traffic-management-shared.

    <FlowCallout async="false" continueOnError="false" enabled="true" name="Traffic-Management-Flow-Callout">
    <DisplayName>Traffic Management FlowCallout</DisplayName>
    <Properties/>
    <SharedFlowBundle>traffic-management-shared</SharedFlowBundle>
</FlowCallout>

    Để biết thêm thông tin, hãy xem phần Gọi luồng được chia sẻ từ proxy API hoặc quy trình chung

  5. Triển khai proxy API đang dùng để bắt đầu sử dụng luồng được chia sẻ. (Để biết thêm thông tin về việc triển khai nói chung, hãy xem phần Tìm hiểu triển khai.)
  6. Phát triển lặp lại bằng cách theo dõi, giống như với proxy API.

    Giống như với proxy API, bạn phát triển một luồng chung bằng cách gọi lặp lại và theo dõi cho đến khi bạn có logic theo cách bạn muốn. Trong trường hợp này, vì luồng được chia sẻ không chạy trên riêng, bạn sẽ gọi một điểm cuối proxy và theo dõi proxy đó.

    Sau đây là các bước:

    1. Đảm bảo rằng cả quy trình chia sẻ và proxy API gọi quy trình đó bằng FlowAnnotation trong cùng một tổ chức và được triển khai cho cùng môi trường.
    2. Trên thẻ Trace (Dấu vết) của proxy API, hãy bắt đầu theo dõi proxy API đó.
    3. Gửi yêu cầu đến một điểm cuối proxy trong proxy API. Luồng từ điểm cuối phải thêm chính sách FlowAnnotation kêu gọi quy trình được chia sẻ.
    4. Trên thẻ Trace (Theo dõi), hãy kiểm tra luồng từ proxy API đến luồng được chia sẻ.

      Lưu ý rằng trong quá trình theo dõi, luồng chung được thể hiện dưới dạng một tập hợp các bước hoặc chính sách trong một hộp màu xám. Biểu tượng đại diện cho chính sách FlowAnnotation trước các luồng được chia sẻ. (Để biết thêm thông tin về cách theo dõi, hãy xem phần Sử dụng công cụ theo dõi.)

Tạo luồng dùng chung trong giao diện người dùng Edge

Khi sử dụng giao diện người dùng Apigee Edge để tạo một quy trình chung, bạn có thể tạo một quy trình chung tại bạn có thể bắt đầu hoặc bằng cách nhập nguồn luồng hiện có dưới dạng tệp .zip gói luồng.

  1. Truy cập vào trang Luồng được chia sẻ, như được mô tả bên dưới. Trên trang Luồng được chia sẻ, bạn có thể xem danh sách các quy trình được chia sẻ trong tổ chức và chỉnh sửa hoặc xoá luồng trong danh sách.

    Edge

    Cách truy cập vào trang Luồng được chia sẻ bằng giao diện người dùng Edge:

    1. Đăng nhập vào apigee.com/edge.
    2. Chọn tổ chức chứa quy trình được chia sẻ của bạn. Hãy xem phần Chuyển đổi giữa các tổ chức.

      Luồng chia sẻ sẽ dùng được cho mọi proxy API và luồng dùng chung được triển khai cho môi trường khỏi tổ chức này. Những người bên ngoài tổ chức này sẽ không truy cập được vào dữ liệu đó.

    3. Chọn Phát triển > Luồng chung trong thanh điều hướng bên trái.

    Classic Edge (Đám mây riêng tư)

    Cách truy cập vào trang Luồng được chia sẻ bằng giao diện người dùng Classic Edge:

    1. Đăng nhập vào http://ms-ip:9000, trong đó ms-ip là Địa chỉ IP hoặc tên DNS của nút Máy chủ quản lý.
    2. Chọn tổ chức chứa quy trình được chia sẻ của bạn. Hãy xem phần Chuyển đổi giữa các tổ chức.

      Luồng chia sẻ sẽ dùng được cho mọi proxy API và luồng dùng chung được triển khai cho môi trường khỏi tổ chức này. Những người bên ngoài tổ chức này sẽ không truy cập được vào dữ liệu đó.

    3. Chọn APIs > Luồng được chia sẻ trong thanh điều hướng trên cùng.
  2. Nhấp vào nút + Luồng chia sẻ để bắt đầu thêm quy trình chia sẻ mới.
  3. Trên trang Tạo quy trình chia sẻ, hãy chọn cách bạn muốn tạo quy trình mới:
    • Tạo một flow mới từ đầu. Bạn có thể định cấu hình các chính sách và tài nguyên như trong quy trình.
      1. Chọn Quy trình chia sẻ trống.
      2. Nhập một giá trị tên. Đây sẽ là tên của proxy API và các luồng dùng chung khác dùng để tham chiếu luồng được chia sẻ này. Tên này phải mô tả dễ hiểu cho nhà phát triển tiêu thụ luồng.
      3. Nhập nội dung mô tả để cung cấp thêm thông tin về chức năng của luồng.
      4. Nhấp vào Tiếp theo.
      5. Chọn những môi trường mà bạn muốn triển khai luồng mới (không bắt buộc).

        Ví dụ: nếu bạn đang kiểm thử luồng được chia sẻ từ các proxy API được triển khai đến môi trường thử nghiệm, sau đó triển khai luồng dùng chung để kiểm thử.

      6. Nhấp vào Build and Deploy (Tạo và triển khai) để tạo và triển khai quy trình dùng chung mới cho (các) môi trường bạn đã chọn. Nếu bạn chọn không có môi trường nào, luồng được chia sẻ sẽ được tạo nhưng không được triển khai.

    • Bạn có thể tạo một luồng chia sẻ từ các nguồn hiện có bằng cách tải một gói luồng lên.
      1. Chọn Gói luồng chia sẻ để chỉ định tệp .zip chứa cấu phần phần mềm mong muốn trong luồng mới.

        Gói luồng dùng chung chứa cấu phần phần mềm nguồn của một luồng dùng chung. Ví dụ: nếu bạn tải xuống luồng được chia sẻ từ giao diện người dùng Edge, bạn sẽ có tệp .zip với gói luồng.

      2. Nhấp vào Tiếp theo.
      3. Nhấp vào Chọn tệp để duyệt tìm tệp .zip có chứa quy trình được chia sẻ bạn muốn nhập.
      4. Trong hộp Tên quy trình chia sẻ, hãy nhập tên cho quy trình đã nhập. Thao tác này sẽ là tên mà proxy API và các luồng dùng chung khác sử dụng để tham chiếu luồng được chia sẻ này. Tên này phải mang tính mô tả cho những nhà phát triển sử dụng flow.
      5. Nhấp vào Tiếp theo.
      6. Nhấp vào Build (Tạo) để tạo quy trình mới từ các nguồn mà bạn đang nhập.

Gọi một luồng dùng chung từ proxy API hoặc luồng dùng chung

Bạn có thể gọi một luồng được chia sẻ từ proxy hoặc từ một luồng được chia sẻ khác bằng cách sử dụng Chính sách về FlowAnnotation.

  1. Trong giao diện người dùng Edge, hãy tìm proxy hoặc luồng được chia sẻ mà bạn muốn dùng để gọi một luồng được chia sẻ khác.
  2. Trong Trình điều hướng, bên cạnh Chính sách, hãy nhấp vào nút +.
  3. Trong danh sách các chính sách, trong mục Tiện ích, hãy nhấp vào FlowChú thích.
  4. Nhập tên và tên hiển thị (mã nhận dạng duy nhất), sau đó chọn quy trình chung mà chính sách của Google sẽ gọi.
  5. Nhấp vào Thêm.
  6. Thêm chính sách FlowAnnotation mới vào proxy mà bạn muốn thực hiện cuộc gọi.

Xem thêm

Kết nối các proxy API với nhau