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

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về 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. Thông thường, bạn cần đồng bộ hoá và điều chỉnh việc triển khai proxy API với các quy trình mà bạn sử dụng hiện nay để phát triển, kiểm thử và triển khai các ứng dụng khác.

Dịch vụ API 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. API RESTful thường được dùng để viết các tập lệnh hoặc mã triển khai proxy API theo phương thức lập trình, hoặc di chuyển proxy API từ môi trường này sang môi trường khác, như một phần của quy trình tự động lớn hơn nhằm triển khai hoặc di chuyển các ứng dụng khác. Dịch vụ API không đưa ra giả định nào về SDLC của bạn (hoặc của bất kỳ ai khác, đối với vấn đề đó). Thay vào đó, thư viện này hiển thị 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 Dịch vụ API được ghi lại trong Tài liệu tham khảo API. Hãy xem Tài liệu tham khảo API khi bắt đầu.

Xem video này để tìm hiể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 có ít nhất hai môi trường triển khai dành cho 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) khác nhau. Mục tiêu của chúng tôi là cung cấp cho bạn một miền mà bạn có thể tạo và xác minh proxy API trước khi API được hiển thị 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á quá trình phát triển proxy API được xử lý bằng 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 xử lý và các proxy API mà ứng dụng đang truy cập trong thời gian chạy. Địa chỉ mạng có sẵn cho mỗi môi trường được xác định trong tập hợp VirtualHosts có sẵn trong môi trường đó.

Đối với lưu lượng truy cập đến, TLS/SSL của máy chủ 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. Giá trị mặc định xác định một địa chỉ HTTP, còn giá trị bảo mật xác định một địa chỉ HTTP/S, với 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 VirtualHosts mà ProxyEndpoint sẽ nghe. Khi chuyển sang phiên bản chính thức, 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ẽ nghe trên HTTP và HTTPS.

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

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

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

Bạn có thể xem Máy chủ ảo nào hiện có trong một môi trường bằng cách chọn Môi trường trong trình đơn chính của giao diện người dùng quản lý.

Môi trường cũng cung cấp tính năng phân tách dữ liệu và tài nguyên. Ví dụ: bạn có thể thiết lập nhiều bộ nhớ đệm trong cả quá trình kiểm thử và phát hành công khai. Chỉ có thể truy cập vào các bộ nhớ đệm này bằng các proxy API thực thi trong môi trường đó. 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 sản xuất và ngược lại.

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

Khi tạo 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 proxy API mới trên phiên bản chính thức, nhưng bạn không nên làm vậy vì có thể hiển thị 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 có thể chuyển proxy API đó 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 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 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ố bản sửa đổi trước đó. Bạn có thể chọn nơi triển khai các bản sửa đổi đó. Ví dụ: bạn có thể quảng bá một bản sửa đổi lên phiên bản chính thức để cho phép nhà phát triển bắt đầu làm việc với API của bạn. Đồng thời, bạn có thể lặp lại nhiều bản sửa đổi trong quá trình kiểm thử, trong đó bạn thêm các tính năng hoặc điều 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 sản phẩm, ghi đè bản sửa đổi hiện có trên môi trường đó. Khi sử dụng phương thức này, bạn luôn có thể cung cấp bản sửa đổi trực tiếp của API cho các nhà phát triển trong khi đang phát triển.

Đã chuyển sang phiên bản chính thức

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

Dịch vụ API cung cấp các tính năng để đảm bảo 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 proxy API để sản xuất 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ề bảo mật, độ tin cậy và tính nhất quán sẽ yêu cầu các nhóm phát triển phải triển khai quy trình tập lệnh. Để thực hiện việc này, bạn có thể viết mã và tập lệnh gọi API RESTful do Dịch vụ API hiển thị.

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

Để có thêm quyền kiểm soát trong quá trình quảng bá, bạn chỉ nên 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 sản phẩm.

Để thực hiện việc này, bạn cần đảm bảo rằng một số tài nguyên liên kết với từng môi trường được định cấu hình sao cho các tài nguyên đó có thể ở trạng thái tĩnh 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 cố định đều được phân phạm vi theo môi trường. Bạn nên đảm bảo rằng các quy ước đặt tên được sử dụng để cho phép 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á. Hãy xem bài viết Tạo và chỉnh sửa bộ nhớ đệm cho môi trường.
  • Mục tiêu ServiceCallout: Chú thích 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ụ.

Để làm cho 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âu lệnh có điều kiện. Bạn có thể sử 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 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.