Vòng đời phát triển API

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X. thông tin

Mỗi tổ chức đều có một vòng đời phát triển phần mềm (SDLC) riêng. Bạn thường cần đồng bộ hoá và điều chỉnh việc triển khai proxy API theo các quy trình mà bạn đang sử dụng để phát triển, kiểm thử và triển khai các ứng dụng khác.

API Services cung cấp các công cụ và API RESTful cho phép bạn tích hợp việc triển khai và quản lý proxy API vào SDLC của tổ chức. Một cách sử dụng phổ biến của API RESTful là viết tập lệnh hoặc mã triển khai các proxy API theo cách có lập trình, hoặc di chuyển các proxy API từ môi trường này sang môi trường khác, trong quy trình tự động hoá lớn hơn cũng triển khai hoặc di chuyển các ứng dụng khác. API Services không đưa ra giả định nào về SDLC của bạn (hoặc của bất kỳ ai khác). Thay vào đó, nó cung cấp các hàm nguyên tử mà nhóm phát triển của bạn có thể điều phối để tự động hoá và tối ưu hoá vòng đời phát triển API.

Các API của Dịch vụ API được ghi lại trong Tài liệu tham khảo API. Xem phần Tài liệu tham khảo API để bắt đầu.

Hãy xem video này để biết thông tin giới thiệu về môi trường API và vòng đời phát triển API.

Môi trường

Mọi tổ chức trên Apigee Edge đều có ít nhất hai môi trường triển khai có sẵn cho các proxy API: "test" và "prod". Sự khác biệt giữa hai môi trường này là tuỳ ý – mỗi môi trường chỉ được xác định bằng một nhóm địa chỉ mạng (URL) riêng biệt. Mục tiêu là cung cấp cho bạn một miền mà bạn có thể tạo và xác minh các proxy API trước khi API được cung cấp cho các nhà phát triển bên ngoài.

Bạn có thể tận dụng các môi trường này để đồng bộ hoá quy trình phát triển proxy API với SDLC. Mỗi môi trường được xác định bằng một địa chỉ mạng, cho phép bạn phân tách lưu lượng truy cập giữa các proxy API mà bạn đang làm việc và những proxy mà các ứng dụng đang truy cập trong thời gian chạy. Địa chỉ mạng có sẵn cho từng môi trường được xác định trong tập hợp VirtualHost có sẵn trong môi trường đó.

TLS/SSL máy chủ đến sẽ tự động được bật cho từng môi trường. Hai VirtualHost được xác định trước trong mỗi môi trường: default và secure. Mặc định xác định một địa chỉ HTTP, trong khi bảo mật xác định một địa chỉ HTTP/S, có TLS/SSL phía máy chủ được định cấu hình sẵn. Trong cấu hình proxy API, bạn chỉ định VirtualHost mà ProxyEndpoint sẽ theo dõi. Khi quảng bá lên prod, bạn thường tắt HTTP bằng cách xoá VirtualHost default khỏi cấu hình proxy API.

Ví dụ: ProxyEndpoint sau đây sẽ theo dõi HTTP và HTTPS.

<HTTPProxyConnection>
  <BasePath>/v0/weather</BasePath>
  <Properties/>
  <VirtualHost>default</VirtualHost>
  <VirtualHost>secure</VirtualHost>
</HTTPProxyConnection>

Bằng cách xoá default VirtualHost khỏi cấu hình ProxyEndpoint, bạn sẽ tạo một proxy API chỉ nhận yêu cầu qua HTTPS chứ không phải HTTP.

<HTTPProxyConnection>
  <BasePath>/v0/weather</BasePath>
  <Properties/>
  <VirtualHost>secure</VirtualHost>
</HTTPProxyConnection>

Bạn có thể xem những VirtualHost có sẵn trong một môi trường bằng cách chọn Environments (Môi trường) trong trình đơn chính của giao diện người dùng quản lý.

Các môi trường cũng cung cấp khả năng phân tách dữ liệu và tài nguyên. Ví dụ: bạn có thể thiết lập các bộ nhớ đệm khác nhau trong quá trình kiểm thử và sản xuất. Chỉ các proxy API thực thi trong môi trường đó mới có thể truy cập vào các bộ nhớ đệm này. Ngoài ra, các khoá API được phát hành trong môi trường thử nghiệm sẽ không hợp lệ trong môi trường phát hành công khai và ngược lại.

Triển khai các proxy API cho môi trường

Khi tạo một proxy API, bạn cần quyết định môi trường mà bạn sẽ làm việc. Bạn có thể chọn tạo một API proxy mới trên bản phát hành chính thức, nhưng không nên làm như vậy vì bạn có thể cung cấp một API cho nhà phát triển trước khi API đó sẵn sàng. Nhìn chung, hãy bắt đầu bằng cách tạo một proxy API trong test. Sau khi kiểm thử, bạn sẽ quảng bá proxy đó lên prod.

Để biết thêm thông tin, hãy xem phần Tìm hiểu về việc triển khai.

Phát triển lặp lại trong quá trình kiểm thử

Khi bạn làm việc trên một proxy API, Dịch vụ API sẽ lưu các lần lặp lại của cấu hình dưới dạng bản sửa đổi. Khi triển khai một proxy API, bạn sẽ chọn một bản sửa đổi cụ thể để triển khai. Thông thường, bạn sẽ triển khai bản sửa đổi gần đây nhất và nếu cần, hãy quay lại số phiên bản trước đó. Bạn có thể chọn nơi triển khai những bản sửa đổi đó. Ví dụ: bạn có thể thăng cấp một bản sửa đổi lên bản phát hành công khai để cho phép nhà phát triển bắt đầu sử dụng API của bạn. Đồng thời, bạn có thể đang lặp lại nhiều bản sửa đổi trên bản kiểm thử, trong đó bạn đang thêm các tính năng hoặc tinh chỉnh chính sách. Sau đó, khi đã sẵn sàng, bạn có thể triển khai bản sửa đổi mới cho prod, ghi đè bản sửa đổi hiện có trên môi trường đó. Bằng phương thức này, bạn luôn có thể cung cấp một bản sửa đổi trực tiếp của API cho các nhà phát triển trong khi bạn đang phát triển.

Thăng hạng lên bản phát hành công khai

Khi một proxy API đã được triển khai và kiểm thử đầy đủ, proxy đó sẽ sẵn sàng được chuyển sang trạng thái "prod". Bản sửa đổi của proxy API trong quá trình kiểm thử sẽ được dùng để ghi đè bản sửa đổi của proxy API được triển khai trên môi trường sản xuất.

API Services cung cấp các chức năng để đảm bảo việc triển khai liền mạch các proxy API, giảm thiểu tác động đến ứng dụng và người dùng cuối trong quy trình triển khai.

Triển khai tập lệnh

Giao diện người dùng quản lý Apigee Edge cho phép bạn triển khai các proxy API cho prod trực tiếp từ trình tạo proxy API. Tuy nhiên, trong nhiều trường hợp, các yêu cầu về tính bảo mật, độ tin cậy và tính nhất quán sẽ bắt buộc các nhóm phát triển phải viết kịch bản cho quy trình triển khai. Để làm như vậy, bạn có thể viết mã và tập lệnh gọi API RESTful do Dịch vụ API cung cấp.

Tài nguyên về môi trường

Để có thêm quyền kiểm soát trong quá trình quảng bá, bạn nên chỉ lặp lại trên các proxy API trong quá trình kiểm thử và thực hiện ít thay đổi nhất có thể đối với các proxy API được triển khai trong môi trường sản xuất.

Để làm như vậy, bạn cần đảm bảo rằng một số tài nguyên nhất định được liên kết với từng môi trường được định cấu hình theo cách mà chúng có thể giữ nguyên trong cấu hình proxy API.

  • URL mục tiêu: Các proxy API thường gọi nhiều URL phụ trợ trong quá trình kiểm thử và phát hành chính thức. Bạn có thể sử dụng cấu hình TargetServer để tạo cấu hình TargetEndpoint độc lập với môi trường. Xem phần Cân bằng tải trên các máy chủ phụ trợ.
  • Bộ nhớ đệm và bản đồ khoá/giá trị: Cả hai tài nguyên duy trì này đều được giới hạn theo môi trường. Bạn nên đảm bảo rằng các quy ước đặt tên được dùng để cho phép các proxy API lưu trữ dữ liệu mà không yêu cầu thay đổi cấu hình trong quá trình quảng bá. Xem phần Tạo và chỉnh sửa bộ nhớ đệm môi trường.
  • Mục tiêu ServiceCallout: Lời kêu gọi dịch vụ có thể sử dụng các mục tiêu khác nhau tuỳ thuộc vào môi trường, ví dụ: nếu ServiceCallout trong môi trường thử nghiệm sử dụng một dịch vụ minh hoạ. Xem Chính sách về chú thích dịch vụ.

Để tạo cấu hình proxy API độc lập với môi trường, bạn cũng có thể sử dụng các câu lệnh có điều kiện. Bạn có thể dùng câu lệnh có điều kiện được tạo bằng biến environment.name để đánh giá môi trường hiện tại trước khi thực thi một chính sách hoặc trước khi định tuyến đến một URL trên phần phụ trợ.

Để biết thêm thông tin, hãy xem phần Tìm hiểu về việc triển khai.