Tạo proxy API từ Đặc tả OpenAPI

Trong hướng dẫn này, bạn sẽ tìm hiểu cách tạo proxy API Edge từ OpenAPI Thông số kỹ thuật sử dụng giao diện quản lý Apigee Edge. Khi bạn gọi proxy API bằng Máy khách HTTP, chẳng hạn như cURL, proxy API sẽ gửi yêu cầu đến mục tiêu mô phỏng Apigee .

Giới thiệu về Open API Initiative

"Sáng kiến API mở (OAI) tập trung vào tạo, phát triển và quảng bá Định dạng mô tả API trung lập cho nhà cung cấp dựa trên Swagger Specification". Để biết thêm thông tin về Sáng kiến API mở, hãy truy cập vào https://openapis.org.

Thông số kỹ thuật OpenAPI sử dụng một định dạng chuẩn để mô tả API RESTful. Được viết ở định dạng JSON hoặc YAML, Thông số kỹ thuật OpenAPI có thể đọc được bằng máy nhưng con người cũng có thể dễ dàng đọc và hiểu. Bản đặc tả mô tả các thành phần như vậy của API làm đường dẫn cơ sở, đường dẫn và động từ, tiêu đề, tham số truy vấn, toán tử, loại nội dung, nội dung mô tả về câu trả lời và nhiều nội dung khác. Ngoài ra, Đặc tả OpenAPI thường được dùng để tạo tài liệu API.

Giới thiệu về dịch vụ mục tiêu mô phỏng Apigee

Dịch vụ mục tiêu mô phỏng Apigee dùng trong hướng dẫn này được lưu trữ tại Apigee và trả về dữ liệu đơn giản. Không cần khoá API hoặc mã truy cập. Trên thực tế, bạn có thể truy cập vào công cụ này trên web trình duyệt. Hãy thử bằng cách nhấp vào nút sau:

http://mocktarget.apigee.net

Dịch vụ đích sẽ trả về lời chào Hello, guest!

Để biết thông tin về tập hợp đầy đủ các API mà dịch vụ mục tiêu mô phỏng hỗ trợ, hãy nhấp vào sau:

http://mocktarget.apigee.net/help

Bạn cần có

• Một tài khoản Apigee Edge. Nếu chưa có tài khoản, bạn có thể đăng ký bằng cách làm theo hướng dẫn về cách Tạo ứng dụng Apigee Edge tài khoản.
• Thông số kỹ thuật OpenAPI. Trong hướng dẫn này, bạn sẽ sử dụng mocktarget.yaml Thông số kỹ thuật OpenAPI mô tả mục tiêu mô phỏng của Apigee dịch vụ của http://mocktarget.apigee.net. Để biết thêm thông tin, hãy xem https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi.
• cURL đã được cài đặt trên máy của bạn để thực hiện lệnh gọi API từ dòng lệnh; hoặc trình duyệt web.

Tạo proxy API

Xin chúc mừng! Bạn đã tạo một proxy API qua một Thông số kỹ thuật OpenAPI. Tiếp theo, bạn sẽ hãy thử nghiệm để biết cách thức hoạt động.

Kiểm tra proxy API

Bạn có thể kiểm thử API Mock-Target-API bằng cURL hoặc trình duyệt web.

Trong cửa sổ dòng lệnh, hãy chạy lệnh cURL sau. Thay thế tên tổ chức của bạn bằng URL.

curl http://<org_name>-test.apigee.net/mock-target-api

Đáp

Bạn sẽ thấy phản hồi sau:

Hello, Guest!        

Bạn làm tốt lắm! Bạn đã tạo một proxy API đơn giản từ một Thông số kỹ thuật OpenAPI và kiểm thử nó.

Thêm tệp XML vào chính sách JSON

Tiếp theo, bạn sẽ thêm chính sách XML vào JSON vào phần Xem phản hồi XML luồng có điều kiện được tạo tự động khi bạn tạo proxy API từ Thông số kỹ thuật OpenAPI. Chính sách này sẽ chuyển đổi phản hồi XML của mục tiêu thành tệp JSON của bạn.

Trước tiên, hãy gọi API để bạn có thể so sánh kết quả với kết quả nhận được sau khi thêm chính sách. Trong cửa sổ dòng lệnh, hãy thực thi lệnh cURL sau. Bạn đang gọi tài nguyên /xml của dịch vụ mục tiêu vốn trả về một khối XML đơn giản. Thay thế tên tổ chức của bạn trong URL.

curl http://<org_name>-test.apigee.net/mock-target-api/xml

Đáp

Bạn sẽ thấy phản hồi sau:

<root> 
  <city>San Jose</city> 
  <firstName>John</firstName> 
  <lastName>Doe</lastName> 
  <state>CA</state> 
</root>

Bây giờ, hãy làm một việc gì đó để chuyển đổi phản hồi XML thành JSON. Thêm chính sách XML vào JSON đối với luồng có điều kiện Xem phản hồi XML trong proxy API.

1. Nhấp vào thẻ Phát triển ở góc trên cùng bên phải của API Mock-Target-API Trang tổng quan trong giao diện người dùng Edge.
   
2. Trong ngăn Điều hướng bên trái, dưới Proxy Endpoints > mặc định, hãy nhấp vào nút View Luồng có điều kiện để phản hồi XML.
   
3. Nhấp vào nút +Bước ở dưới cùng, tương ứng với Phản hồi cho quy trình.
   
   Hộp thoại Thêm bước sẽ mở ra để hiển thị danh sách được phân loại gồm tất cả các chính sách mà bạn có thể thêm.
   
4. Chuyển đến danh mục Dàn xếp rồi chọn XML sang JSON.
   
5. Giữ các giá trị mặc định cho Display Name (Tên hiển thị) và Tên.
6. Nhấp vào Thêm. Chính sách XML cho JSON được áp dụng cho phản hồi.
7. Nhấp vào Lưu.

Bây giờ, bạn đã thêm chính sách, hãy gọi lại API bằng cURL. Lưu ý rằng bạn vẫn gọi cùng một tài nguyên /xml. Dịch vụ đích vẫn trả về khối XML, nhưng chính sách trong proxy API sẽ chuyển đổi phản hồi thành JSON. Tạo món này gọi điện:

curl http://<org_name>-test.apigee.net/mock-target-api/xml

Lưu ý: phản hồi XML được chuyển đổi thành JSON:

{"root":{"city":"San Jose","firstName":"John","lastName":"Doe","state":"CA"}}

Xin chúc mừng! Bạn đã thử nghiệm thành công việc thực thi chính sách được thêm vào luồng có điều kiện.