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 có một vòng đời phát triển phần mềm (SDLC) riêng biệt. Thông thường, để đồng bộ hoá và điều chỉnh việc triển khai proxy API với chính những quy trình mà bạn hiện đang sử 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 việc triển khai proxy API và quản lý vào SDLC của tổ chức bạn. API RESTful có cách dùng phổ biến để ghi các tập lệnh hoặc mã triển khai proxy API theo cách có lập trình hoặc di chuyển các proxy API từ một sang một môi trường khác, như một phần của một quy trình tự động lớn hơn, đồng thời triển khai hoặc di chuyển cá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, vì điều đó vấn đề). Thay vào đó, nó cho thấy 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.

Các API của Dịch vụ API được nêu trong Tài liệu tham khảo API. Xem Lấy tệp tham chiếu API đã bắt đầu.

Xem video này để biết giới thiệu về môi trường API và quá trình phát triển API vòng đời.

Môi trường

Mỗi tổ chức sử dụng Apigee Edge đều có sẵn ít nhất 2 môi trường triển khai đối với proxy API: "test" (kiểm thử) và "prod". Sự khác biệt giữa hai môi trường là tuỳ ý — mỗi môi trường được xác định đơn giản bằng một tập hợp địa chỉ mạng (URL) khác nhau. Chiến lược phát hành đĩa đơn 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 API được hiển thị với 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. 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 riêng lưu lượng truy cập giữa các proxy API mà bạn đang xử lý cũng như các proxy mà ứng dụng truy cập được trong thời gian chạy. Các đị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 đó.

Được gửi đến, TLS/SSL của máy chủ được tự động bật cho mỗi 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 bảo mật lại xác định một địa chỉ HTTP/S, với TLS/SSL phía máy chủ được định cấu hình trước. Trong cấu hình proxy API, bạn cho biết ProxyEndpoint nên nghe Máy chủ ảo nào. Khi quảng bá lên phiên bản chính thức, bạn thường tắt HTTP bằng cách xoá default VirtualHost qua 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 tạo một proxy API chỉ theo dõi trên HTTPS chứ không theo dõi trên HTTP.

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

Bạn có thể xem VirtualHost 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 giúp 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 thử nghiệm và sản xuất mà chỉ có thể truy cập được bằng proxy API thực thi trong môi trường. Ngoài ra, 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à mình sẽ làm việc. Bạn có thể chọn tạo một proxy API mới trên kênh phát hành công khai, nhưng bạn không nên làm như vậy vì bạn có thể bị lộ một API cho nhà phát triển trước khi API đó sẵn sàng. Nói chung, hãy bắt đầu bằng cách tạo proxy API trong test mà sau khi thử nghiệm, bạn sẽ quảng bá lên prod.

Để biết thêm thông tin, hãy xem 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 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 triển khai bản sửa đổi gần đây nhất và nếu cần, hoàn nguyên về bản sửa đổi trước đó số bản sửa đổi. 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á bản sửa đổi thành sản phẩm để 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 khi kiểm thử, trong đó bạn sẽ thêm các tính năng hoặc tinh chỉnh các 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 chính thức, ghi đè lên bản sửa đổi hiện có môi trường đó. Khi sử dụng phương thức này, bạn luôn có thể có bản sửa đổi trực tiếp của API để trong quá trình phát triển.

Quảng bá cho sản phẩm

Khi một proxy API đã được triển khai và thử nghiệm đầy đủ, proxy đó sẽ sẵn sàng được quảng bá lên "sản phẩm". Bản sửa đổi proxy API đang được 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.

Dịch vụ API cung cấp các tính 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.

Tập lệnh triển khai

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ừ API trình tạo proxy. 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à nhất quán sẽ yêu cầu các nhóm phát triển thực hiện quy trình triển khai tập lệnh. Để 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 hiển thị.

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

Để có thêm quyền kiểm soát trong thời gian quảng bá, bạn chỉ nên lặp lại trên API proxy trong thử nghiệm 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 sản phẩm.

Để thực hiện điều nà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 mỗi môi trường được định cấu hình sao cho chúng có thể ở dạng tĩnh trong cấu hình proxy API.

  • URL mục tiêu: Các proxy API thường gọi các URL phụ trợ khác nhau trong quá trình thử nghiệm và sản xuất. Bạn có thể sử dụng các cấu hình TargetServer để tạo độc lập về môi trường Cấu hình TargetEndpoint. Xem Cân bằng tải giữa 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 nằm trong phạm vi của 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 các thay đổi về cấu hình trong thời gian quảng bá. Xem Tạo và chỉnh sửa bộ nhớ đệm môi trường.
  • Mục tiêu chú thích dịch vụ: Chú thích dịch vụ có thể sử dụng các mục tiêu khác nhau tùy thuộc vào của riêng mình, chẳng hạn như nếu một chú thích dịch vụ trong môi trường thử nghiệm sử dụng 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 điều kiện tuyên bố. Câu lệnh có điều kiện được tạo bằng biến environment.name có thể được dùng để đá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ề hoạt động triển khai.