Công cụ phát triển

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

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ì các proxy API và sản phẩm API, bạn có thể sử dụng giao diện người dùng hoặc đưa ra các 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ể dùng để tạo, định cấu hình và quản lý các sản phẩm API và proxy API. Bạn cũng chỉ có thể hoàn thành một số nhiệm 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.
Edge cho Đám mây riêng tư  Giao diện người dùng Edge kiểu cũ

Để truy cập vào giao diện người dùng Edge cho Edge 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 các luồng yêu cầu thông qua proxy của bạn.
  • Tạo các sản phẩm API kết hợp các proxy để hiển thị cho các yêu cầu của ứng dụng.
  • 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à môi trường phát hành công khai.
  • Triển khai các ứng dụng JavaScript và Node.js.

Hình ảnh sau đây minh hoạ 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 một proxy API:

Cho biết thẻ Develop (Phát triển) được 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ác API này cũng cung cấp quyền truy cập vào các chức 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 điểm cuối đó. Theo các nguyên tắc 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.

Để xem danh sách đầy đủ 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ở Edge API

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

  • Một đường dẫn cơ sở có 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 đến 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 các 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 giới hạn theo môi trường. Theo mặc định, có hai môi trường được cung cấp: kiểm thử và prod. Ví dụ: bộ nhớ đệm được giới hạn theo môi trường. Theo mặc định, mọi môi trường đều có một bộ nhớ đệm dùng chung có tên là "mycache".

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 xác thực chính mình với máy chủ API khi gọi các API. Bạn có thể thực hiện việc này theo một trong những cách sau:

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

Giới hạn Edge API

Mỗi tổ chức chỉ được phép gọi API Edge với tốc độ sau:

  • 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 hạn mức này. Mọi lệnh gọi vượt quá các giới hạn này đều trả về mã trạng thái 429 Too Many Requests.

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

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

Rút gọn URL yêu cầu

Khi tạo URL yêu cầu cho Edge API, 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 nhất quán. Tức là bạn phải rút gọn tất cả các phần tử trong đường dẫn, như đã lưu ý ở trên và minh hoạ trong ví dụ sau, hoặc không rút gọn phần tử nào. 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 một ứng dụng HTTP để gửi yêu cầu đến API. Nhiều ví dụ trong tài liệu cung cấp các yêu cầu API mẫu bằng cách sử dụng curl, một ứng dụng HTTP được dùng rộng rãi. Nếu cần cài đặt curl, bạn có thể tải xuống từ http://curl.haxx.se.

Các lệnh gọi đến API hỗ trợ tính năng nén 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 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 được phản hồi được gửi lại dưới dạng XML. Để thực hiện 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 để hiển thị kết quả bằng cách truyền phản hồi qua xmllint.

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

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

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 POSTing hoặc PUTting tải trọng 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 API: "test" và "prod". Sử dụng môi trường "kiểm thử" để phát triển và kiểm thử API trước khi cung cấp công khai. Chỉ 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 cho môi trường thử nghiệm. Triển khai API của bạn vào môi trường "prod" để cung cấp công khai 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 cho phép bạn gỡ lỗi các quy trình yêu cầu và phản hồi toàn diện. Kết quả theo dõi hiển thị các tiêu đề và tải trọng 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 quy trình.

Các điểm dữ liệu chính để sử dụng trong việc 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 từng bước. Việc so sánh dấu thời gian giúp bạn tách biệt những chính sách mất nhiều thời gian nhất để thực thi, làm chậm các lệnh gọi API của bạn.
  • Đườ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: Những kết quả này cho phép bạn biết liệu thông báo có đang bị thay đổi như mong đợi hay không, chẳng hạn như liệu thông báo có đang được chuyển đổi từ XML sang JSON hay không, hoặc liệu 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:

Cho biết 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 thành các bước chính sau đây:

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