Bước 6: Xuất bả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

Ở bước này, bạn sẽ phát hành API lên cổng thông tin bằng cách thực hiện các bước sau:
1. Tạo thông số kỹ thuật OpenAPI
2. Tạo proxy API theo quy cách
3. Tạo sản phẩm API
4. Phát hành API lên cổng thông tin

Bước 1: Tạo thông số kỹ thuật OpenAPI

Mỗi Thông số kỹ thuật OpenAPI đóng vai trò là nguồn đáng tin cậy trong suốt vòng đời của API. Bạn sử dụng cùng một thông số kỹ thuật ở từng giai đoạn trong vòng đời của API, từ khi phát triển đến khi phát hành.

Cách tạo Thông số kỹ thuật OpenAPI:

1. Chọn Phát triển > Thông số kỹ thuật trong thanh điều hướng bên trái để mở trang Thông số kỹ thuật.
2. Nhấp vào + Thông số kỹ thuật > Nhập URL.
3. Nhập thông tin sau vào hộp thoại nhập:
4. Nhập tên: helloworld

5. Url nhập: https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml

6. Nhấp vào Nhập.

Bước 2: Tạo Proxy API từ một thông số kỹ thuật

Tạo proxy API từ Thông số kỹ thuật OpenAPI mô tả API.

Cách tạo proxy API từ Thông số kỹ thuật OpenAPI:

1. Trên trang Thông số kỹ thuật, hãy đặt con trỏ lên thông số kỹ thuật helloworld để hiển thị trình đơn thao tác.
2. Nhấp vào để tạo một proxy API từ phần thông số kỹ thuật.
   Trình hướng dẫn Tạo proxy sẽ mở ra và trang Chi tiết được điền sẵn bằng các giá trị lấy từ Thông số kỹ thuật của OpenAPI.
3. Chỉnh sửa trường Mô tả như sau: Uỷ quyền API cho lời chào thế giới.
4. Nhấp vào Tiếp theo.

5. Trên trang Chính sách:

   • Trong mục Bảo mật: Uỷ quyền, hãy chọn Chuyển qua (không được uỷ quyền).
   • Trong phần Bảo mật: Trình duyệt, hãy chọn Thêm tiêu đề CORS .

   

6. Nhấp vào Tiếp theo.

7. Trên trang Flow (Luồng), hãy đảm bảo bạn đã chọn tất cả các thao tác rồi nhấp vào Next (Tiếp theo).
   

8. Trên trang Virtual Hosts (Máy chủ ảo), hãy đảm bảo tất cả các máy chủ ảo đều đã được chọn rồi nhấp vào Next (Tiếp theo).

9. Trên trang Tóm tắt, hãy chọn môi trường bạn muốn triển khai trong phần Triển khai tuỳ chọn.

   

10. Nhấp vào Tạo.

Trên trang Tóm tắt, bạn sẽ thấy thông báo xác nhận rằng proxy API mới đã được tạo thành công và triển khai trong môi trường thử nghiệm.

Bước 3: Tạo một sản phẩm API

Tạo một sản phẩm API chứa các tài nguyên API mà bạn muốn hiển thị cho người dùng API của mình.

Cách tạo một sản phẩm API:

1. Chọn Publish > API Products (Xuất bản > Sản phẩm API) trên thanh điều hướng bên trái để mở trang Sản phẩm API.
2. Nhấp vào + Sản phẩm API.
   Trang Sản phẩm mới sẽ xuất hiện.
3. Nhập Product Details (Chi tiết sản phẩm) cho sản phẩm API của bạn.
   Lưu ý: Theo mặc định, các trường Tên hiển thị và Mô tả sẽ xuất hiện trong cổng thông tin khi bạn xuất bản sản phẩm API. Bạn có thể chỉnh sửa các giá trị trong Bước 4: Xuất bản API lên cổng thông tin của bạn.
   

   Trường	Giá trị
   Tên	Xin chào mọi người
   Tên hiển thị	Xin chào mọi người
   Nội dung mô tả	Ví dụ về lời chào thế giới đơn giản
   Môi trường	Chọn môi trường nơi triển khai proxy API.
   Quyền truy cập	Quản lý
   Tự động phê duyệt các yêu cầu cấp quyền truy cập	Đã bật
   Hạn mức	(để trống)
   Phạm vi OAuth được phép	(để trống)

4. Trong phần Tài nguyên API, hãy nhấp vào Thêm proxy để xác định các proxy API cần thêm vào sản phẩm API của bạn.
   Hộp thoại Add API Resource (Thêm tài nguyên API) sẽ xuất hiện.
5. Nhấp vào API Proxy (nếu chưa chọn) rồi chọn Mock-Target-API trong danh sách.
6. Nhấp vào Thêm.
7. Nhấp vào Lưu để lưu sản phẩm API.

   

Bước 4: Xuất bản API lên cổng thông tin của bạn

Xuất bản API lên cổng thông tin của bạn để cho phép khách hàng tìm hiểu và sử dụng API.

Cách xuất bản API lên cổng thông tin của bạn:

1. Chuyển đến trang API trong cổng thông tin của bạn:
   1. Chọn Xuất bản > Cổng trong thanh điều hướng bên trái.
   2. Nhấp vào hàng Cổng thông tin đầu tiên của tôi để mở cổng.
   3. Nhấp vào Danh mục API để hiển thị trang API.
2. Nhấp vào +.
3. Chọn Hello World (Xin chào mọi người) trong hộp thoại Add an API product to the Catalog (Thêm sản phẩm API vào danh mục) rồi nhấp vào Next (Tiếp theo).
4. Trong phần Thông tin chi tiết về API, hãy định cấu hình các tuỳ chọn sau:
   • Chọn Đã xuất bản (được liệt kê trong danh mục) để xuất bản API lên cổng thông tin của bạn.
   • Đối với Ảnh hiển thị:
     1. Nhấp vào Chọn hình ảnh.
     2. Nhấp vào home-background.jpg từ danh sách hình ảnh hiện có trong hộp thoại Chọn hình ảnh.
     3. Nhấp vào Chọn.
     4. Xem trước hình ảnh rồi nhấp vào Chọn.
   • Đối với Danh mục, hãy nhập Bắt đầu rồi nhấn phím Enter.

   Giữ nguyên tất cả giá trị khác theo giá trị mặc định.

5. Trong Tài liệu về API, để tự động tạo tài liệu tham khảo API qua thông tin tổng quan nhanh về Thông số kỹ thuật OpenAPI:
   1. Chọn OpenAPI document (Tài liệu OpenAPI).
   2. Nhấp vào Chọn tài liệu.
   3. Chọn tab Thông số kỹ thuật của tôi (nếu chưa chọn).
   4. Chọn helloworld trong danh sách thông số.
   5. Nhấp vào Chọn.
6. Nhấp vào Lưu để lưu thông tin chi tiết về API.

   

Cách xem tài liệu tham khảo API:

1. Nhấp vào Cổng trực tiếp để xem các thay đổi trong cổng trực tiếp (hoặc làm mới cổng trực tiếp nếu cổng đó đã mở trong một thẻ khác).
2. Nhấp vào API trong thanh điều hướng trên cùng để xem API đã xuất bản.
3. Nhấp vào thẻ Hello World (Xin chào mọi người) để xem tài liệu tham khảo API. Hãy dùng thử API của bạn!

---

Xin chúc mừng! Bạn đã hoàn tất thành công phần hướng dẫn. Bạn đã sẵn sàng tìm hiểu thêm? Chuyển đến phần Xây dựng cổng thông tin tích hợp.