Công cụ phát triển

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

Là nhà cung cấp dịch vụ, bạn phát triển các API để ứng dụng khách sử dụng. Để tạo, định cấu hình và duy trì proxy API cũng như các sản phẩm API, bạn có thể sử dụng giao diện người dùng hoặc đưa ra yêu cầu HTTP đến các API để truy cập vào các dịch vụ RESTful, như mô tả trong các phần sau.

Sử dụng giao diện người dùng Edge

Giao diện người dùng Apigee Edge là một công cụ dựa trên trình duyệt mà bạn có thể sử dụng để tạo, định cấu hình và quản lý các proxy API cũng như các sản phẩm API. Bạn cũng chỉ có thể hoàn thành một số tác vụ bằng API.

Bảng sau đây mô tả cách truy cập vào giao diện người dùng Edge:

Sản phẩm Tên giao diện người dùng URL truy cập
Edge Giao diện người dùng Edge

Để truy cập vào giao diện người dùng Edge, hãy sử dụng URL sau:

https://apigee.com/edge

Để xem hướng dẫn về cách sử dụng giao diện người dùng Edge, hãy xem phần Tạo proxy API đầu tiên của bạn.
Edge cho đám mây riêng tư Giao diện người dùng của Edge cổ điển

Để truy cập vào giao diện người dùng Edge cho Edge dành cho đám mây riêng tư, hãy sử dụng URL sau:

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ý.

Khi sử dụng giao diện người dùng Edge, bạn có thể:

  • Tạo proxy API bằng cách chỉnh sửa mã và theo dõi luồng yêu cầu thông qua các proxy của bạn.
  • Tạo các sản phẩm API gói các proxy để hiển thị các yêu cầu của ứng dụng khách.
  • Quản lý nhà phát triển và ứng dụng của nhà phát triển.
  • Định cấu hình môi trường kiểm thử và thực tế.
  • Triển khai các ứng dụng JavaScript và Node.js.

Hình ảnh sau đây hiển thị trình chỉnh sửa proxy API trong giao diện người dùng mà bạn có thể dùng để tạo và định cấu hình proxy API:

Hiển thị thẻ Phát triển đã chọn trong trình chỉnh sửa proxy API trong giao diện người dùng Edge.

Sử dụng Edge API

Bạn có thể sử dụng Edge API để quản lý các tài nguyên API của mình. Các API này cũng cấp quyền truy cập vào các tính năng cấp thấp mà giao diện người dùng không hiển thị.

Các điểm cuối API thường lấy dữ liệu chứa thông tin cấu hình và yêu cầu bạn truyền thông tin xác thực (chẳng hạn như tên người dùng và mật khẩu) để truy cập vào các dữ liệu đó. Theo các nguyên tắc của RESTful, bạn có thể gọi các phương thức HTTP GET, POST, PUT và DELETE trên bất kỳ tài nguyên API nào.

Để biết danh sách đầy đủ về các API Apigee Edge, hãy xem Tài liệu tham khảo về API Apigee Edge.

Tìm hiểu đường dẫn cơ sở của API Edge

Đường dẫn mà bạn sẽ sử dụng trong các yêu cầu API nối những phần sau:

  • Đường dẫn cơ sở bao gồm tên tổ chức của bạn. Ví dụ: https://api.enterprise.apigee.com/v1/organizations/org_name
  • Một điểm cuối trỏ đến tài nguyên Edge mà bạn đang truy cập.

Ví dụ: nếu tên tổ chức của bạn là apibuilders, thì mọi lệnh gọi bạn thực hiện tới API sẽ sử dụng đường dẫn cơ sở sau:

https://api.enterprise.apigee.com/v1/organizations/apibuilders

Để truy xuất danh sách proxy API trong tổ chức của mình, bạn sẽ gọi GET trên:

https://api.enterprise.apigee.com/v1/organizations/apibuilders/apis

Nhiều tài nguyên được xác định theo môi trường. Hai môi trường được cung cấp theo mặc định là môi trường thử nghiệm và thực tế. Ví dụ: bộ nhớ đệm được xác định phạm vi theo môi trường. Theo mặc định, bộ nhớ đệm dùng chung có tên "mycache" sẽ được đưa vào mọi môi trường.

Bạn có thể liệt kê các bộ nhớ đệm bằng cách gọi GET trên tài nguyên bộ nhớ đệm như sau:

https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/test/caches
https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/prod/caches

Xác thực quyền truy cập

Bạn phải tự xác thực với máy chủ API khi gọi API. Bạn có thể thực hiện việc này theo một trong các cách sau:

Ngoài ra, Apigee bạn nên sử dụng tính năng xác thực hai yếu tố như mô tả trong bài viết Bật tính năng xác thực hai yếu tố cho tài khoản Apigee.

Các giới hạn đối với API Edge

Mỗi tổ chức chỉ được áp dụng các mức giá gọi sau đây của Edge API:

  • 10.000 cuộc gọi mỗi phút đối với các tổ chức sử dụng gói có tính phí
  • 600 cuộc gọi mỗi phút đối với các tổ chức dùng thử

Mã trạng thái HTTP 401 và 403 không được tính vào giới hạn này. Mọi lệnh gọi vượt quá các giới hạn này đều sẽ trả về mã trạng thái 429 Too Many Requests.

Mẹo làm việc với API Edge

Phần này mô tả một số kỹ thuật giúp làm việc với các API Edge dễ dàng hơn.

URL yêu cầu viết tắt

Khi tạo URL yêu cầu cho các API Edge, bạn có thể sử dụng các từ viết tắt sau:

  • /e = /environments
  • /o = /organizations
  • /r = /revisions

Nếu sử dụng từ viết tắt, bạn phải sử dụng chúng một cách nhất quán. Tức là viết tắt tất cả các thành phần trong đường dẫn (như đã nêu ở trên và minh hoạ trong ví dụ sau) hoặc không viết tắt. Việc sử dụng cả phần tử đầy đủ và phần tử viết tắt trong cùng một đường dẫn sẽ dẫn đến lỗi.

Ví dụ:

THIS:
https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/environments/prod/apis/helloworld/revisions/1/deployments
CAN BE MUCH SHORTER:
https://api.enterprise.apigee.com/v1/o/ahamilton-eval/e/prod/apis/helloworld/r/1/deployments

Thực thi các lệnh curl

Sử dụng ứng dụng HTTP để gửi yêu cầu đến API. Tài liệu này có nhiều ví dụ cung cấp các yêu cầu API mẫu bằng curl (một ứng dụng HTTP được sử dụng rộng rãi). Nếu cần cài đặt curl, bạn có thể tải ứng dụng này xuống từ http://curl.haxx.se.

Các lệnh gọi đến API hỗ trợ nén tệp gzip đối với các phản hồi. Nếu bạn đặt 'Accept-Encoding: gzip, deflate' trong các lệnh gọi API, mọi phản hồi lớn hơn 1024 byte sẽ được trả về ở định dạng gzip.

Định dạng các yêu cầu và phản hồi XML và JSON

Theo mặc định, Edge API trả về dữ liệu dưới dạng JSON. Đối với nhiều yêu cầu, bạn có thể nhận phản hồi được gửi lại dưới dạng XML. Để làm việc này, hãy đặt tiêu đề của yêu cầu Accept thành application/xml, như trong ví dụ sau:

curl -H "Authorization: Bearer `get_token`" \
  -H "Accept: application/xml" \
  https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apis/helloworld/revisions/1/policies/ \
  | xmllint --format -

Phản hồi sẽ có dạng như sau:

<List>
  <Item>SOAP-Message-Validation-1</Item>
  <Item>Spike-Arrest-1</Item>
  <Item>XML-to-JSON-1</Item>
</List>

Xin lưu ý rằng ví dụ này sử dụng prettyprint để cho thấy kết quả bằng cách đặt đường ống phản hồi thông qua xmllint.

Tiện ích acurl không hỗ trợ tiêu đề Accept. Do đó, bạn chỉ có thể nhận được phản hồi có định dạng JSON bằng acurl.

Để dùng prettyprint cho phản hồi JSON, bạn có thể sử dụng thư viện Python json.tool:

curl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apis/helloworld/revisions/1/policies/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer `get_token`" \
  | python -m json.tool

Sau đây là ví dụ về phản hồi:

[
  "SOAP-Message-Validation-1",
  "Spike-Arrest-1",
  "XML-to-JSON-1"
]

Đối với XML, bạn có thể sử dụng xmllint:

curl https://ahamilton-eval-test.apigee.net/getstarted -u email_address | xmllint --format -

Khi POST hoặc PUTting payload trong XML, hãy sử dụng tiêu đề HTTP Content-type:

acurl -H "Content-type:text/xml" -X POST -d \
'<XMLPayload>
 </XMLPayload> ' \
https://api.enterprise.apigee.com/v1/organizations/apifactory/apis -u email_address

Môi trường triển khai

Theo mặc định, mỗi tổ chức sử dụng Apigee Edge đều có ít nhất 2 môi trường mà họ có thể dùng để phát triển, kiểm thử và triển khai các API: "kiểm thử" và "sản xuất". Hãy sử dụng môi trường "kiểm thử" để phát triển và kiểm thử các API của bạn trước khi cung cấp công khai. Chỉ những nhà phát triển nội bộ của bạn mới có thể truy cập vào các API được triển khai trong môi trường thử nghiệm. Triển khai các API của bạn trong môi trường "thực tế" để cung cấp công khai các API đó cho nhà phát triển ứng dụng.

Gỡ lỗi và thử nghiệm

Apigee cung cấp một công cụ theo dõi giúp bạn gỡ lỗi toàn diện cho các quy trình yêu cầu và phản hồi. Kết quả theo dõi cho thấy các tiêu đề và tải trọng của yêu cầu và phản hồi, quá trình thực thi chính sách, giá trị biến và mọi lỗi có thể đã xảy ra trong luồng.

Các điểm dữ liệu chính dùng khi khắc phục sự cố:

  • Dấu thời gian: Sử dụng dấu thời gian để xem thời gian thực hiện mỗi bước. Thao tác so sánh dấu thời gian sẽ giúp bạn tách biệt những chính sách đang làm chậm lệnh gọi API mà đang mất nhiều thời gian thực thi nhất.
  • Đường dẫn cơ sở: Bằng cách xác minh đường dẫn cơ sở, bạn có thể đảm bảo rằng một chính sách đang định tuyến thông báo đến đúng máy chủ.
  • Kết quả thực thi chính sách: Các kết quả này cho bạn biết liệu thông báo có được thay đổi như dự kiến hay không, chẳng hạn như thông báo có đang được chuyển đổi từ XML sang JSON hay không hoặc thông báo có đang được lưu vào bộ nhớ đệm hay không.

Hình sau đây cho thấy kết quả theo dõi:

Hiển thị thẻ Theo dõi được chọn trong trình chỉnh sửa proxy API trong giao diện người dùng Edge.

Mỗi phiên Theo dõi được chia nhỏ thành các bước chính sau đây:

  • Yêu cầu ban đầu nhận được từ ứng dụng: Cho thấy động từ và đường dẫn URI của yêu cầu từ ứng dụng khách, tiêu đề, dữ liệu nội dung và tham số truy vấn.
  • Yêu cầu gửi đến dịch vụ phụ trợ: Hiển thị thông báo yêu cầu do proxy API gửi đến dịch vụ phụ trợ.
  • Phản hồi do dịch vụ phụ trợ trả về: Cho thấy các tiêu đề phản hồi và tải trọng do dịch vụ phụ trợ trả về.
  • Phản hồi cuối cùng được gửi đến ứng dụng: Thông báo phản hồi được trả về ứng dụng yêu cầu sau khi quy trình phản hồi đã thực thi.