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 phải đồng bộ hoá và điều chỉnh quy trình triển khai proxy API cho chính các quy trình mà bạn hiện đang dùng để 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 hoạt động 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 các tập lệnh hoặc mã có lập trình triển khai proxy API, 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 một quy trình tự động lớn hơn, trong đó 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 về SDLC của bạn (hoặc của bất kỳ ai khác, đối với vấn đề này). Thay vào đó, công cụ này hiển thị các chức năng 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.

API của Dịch vụ API được nêu trong Tài liệu tham khảo API. Hãy xem Tài liệu tham khảo API để bắt đầu sử dụng.

Môi trường

Mỗi tổ chức sử dụng Apigee Edge đều có ít nhất 2 môi trường triển khai dành cho proxy API: "test" (kiểm thử) và "prod". Sự khác biệt giữa 2 môi trường là tuỳ ý — mỗi môi trường được xác định đơn giản bằng một nhóm địa chỉ mạng (URL) khác nhau. Mục tiêu là cung cấp cho bạn một miền mà trong đó bạn có thể tạo và xác minh proxy API trước khi API 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ý với SDLC của mình. Mỗi môi trường được xác định bằng một địa chỉ mạng, cho phép bạn tách biệt lưu lượng truy cập giữa các proxy API mà bạn đang xử lý và những proxy 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 các VirtualHost có sẵn trong môi trường đó.

Trong thư, 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. Mặc định xác định địa chỉ HTTP, trong khi phần bảo mật xác định đị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 sẽ chỉ định xem ProxyEndpoint nào sẽ theo dõi trên Máy chủ ảo nào. Khi quảng bá lên giai đoạn phát hành 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 theo dõi trên HTTP và HTTPS.

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

Bằng cách xoá VirtualHost 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 phải trên HTTP.

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

Bạn có thể xem VirtualHost nào 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 cho phép 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 môi trường thử nghiệm và chính thức. Chỉ các proxy API thực thi trong môi trường đó mới có thể truy cập vào những bộ nhớ này. Ngoài ra, các khoá API được phát hành trong môi trường kiểm thử sẽ không hợp lệ trong môi trường thực 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ình sẽ làm việc. Bạn có thể chọn tạo một proxy API mới khi phát hành chính thức. Tuy nhiên, bạn không nên làm vậy vì có thể bạn sẽ thấy 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á lên prod.

Để biết thêm thông tin, hãy xem bài viết Tìm hiểu về cách 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 vòng lặp của cấu hình dưới dạng bản sửa đổi. Khi triển khai proxy API, bạn 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 khôi phục về số bản sửa đổi 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ể 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 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 lên phiên bản chính thức, ghi đè bản sửa đổi hiện có trên môi trường đó. Bằng cách sử dụng phương thức này, bạn luôn có thể cung cấp cho nhà phát triển bản sửa đổi trực tiếp của API trong quá trình phát triển.

Khuyến mãi cho sản phẩm

Khi một proxy API đã được triển khai và kiểm thử đầy đủ, proxy đó sẽ sẵn sàng để được nâng cấp lên "prod". Bản sửa đổi proxy API trong quá trình kiểm thử sẽ được dùng để ghi đè bản sửa đổi proxy API được triển khai trên sản phẩm chính thức.

Dịch vụ API cung cấp các tính năng giúp đả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 quá 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 để 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ẽ buộc nhóm phát triển phải thực hiện quy trình triển khai theo 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

Để tăng cường kiểm soát trong quá trình khuyến mãi, 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 một vài thay đổi cần thiết đối với các proxy API được triển khai trong phiên bản chính thức.

Để thực hiện việc này, bạn cần đảm bảo rằng một số tài nguyên nhất định liên kết với từng môi trường được định cấu hình theo cách có thể duy trì 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à sản xuất. 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 nội dung 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 về lưu trữ đều được xác định phạm vi theo môi trường. Bạn nên đảm bảo rằng quy ước đặt tên được sử 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 khuyến mãi. Xem phần Tạo và chỉnh sửa bộ nhớ đệm của môi trường.
• Mục tiêu chú thích dịch vụ: Chú thích về 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, chẳng hạn như trong trường hợp Chú thích dịch vụ trong môi trường thử nghiệm sử dụng dịch vụ minh hoạ chẳng hạn. 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ể 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 bài viết Tìm hiểu về cách triển khai.