Bước 6: Xuất bản API

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

Trong bước này, bạn sẽ xuất bản một API lên cổng thông tin bằng cách thực hiện các bước sau:
1. Tạo một Đặc tả OpenAPI
2. Tạo một proxy API từ một thông số kỹ thuật
3. Tạo một sản phẩm API
4. Xuất bản API lên cổng thông tin

Bước 1: Tạo một Đặc tả OpenAPI

Mỗi Đặc tả OpenAPI đóng vai trò là nguồn dữ liệu đáng tin cậy trong suốt vòng đời API. Cùng một quy cách được dùng ở mỗi giai đoạn trong vòng đời của API, từ giai đoạn phát triển đến xuất bản.

Cách tạo một Đặc 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 + Spec > Import URL (+ Quy cách > Nhập URL).
3. Nhập thông tin sau vào hộp thoại nhập:
4. Tên tệp nhập: helloworld

5. Nhập URL: 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 một API Proxy từ một thông số kỹ thuật

Tạo một proxy API từ một Đặc tả OpenAPI mô tả API.

Cách tạo một proxy API từ một Quy cách OpenAPI:

1. Trên trang Specs (Thông số kỹ thuật), hãy di chuyển con trỏ lên thông số kỹ thuật helloworld để trình đơn thao tác xuất hiện.
2. Nhấp vào để tạo một proxy API từ quy cách.
   Trình hướng dẫn Build a Proxy (Tạo proxy) sẽ mở ra và trang thông tin chi tiết được điền sẵn bằng các giá trị từ OpenAPI Specification (Quy cách OpenAPI).
3. Chỉnh sửa trường Description (Nội dung mô tả) như sau: API proxy for hello world. (API proxy cho chương trình hello world.)
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 Truy cập trực tiếp (không uỷ quyền).
   • Trong mục 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 Flows (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 bạn đã chọn tất cả máy chủ ảo 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 mà bạn muốn triển khai trong mục Triển khai không bắt buộc.

   

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 bạn đã tạo thành công và triển khai proxy API mới vào 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 cung cấp cho người dùng API.

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

1. Chọn Xuất bản > Sản phẩm API trong thanh điều hướng bên trái để mở trang Sản phẩm API.
2. Nhấp vào + API Product (Sản phẩm API).
   Trang Sản phẩm mới sẽ xuất hiện.
3. Nhập Thông tin chi tiết về sản phẩm cho sản phẩm API của bạn.
   Lưu ý: Các trường Tên hiển thị và Nội dung 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 theo mặc định. 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.
   

   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
   Mô tả	Ví dụ đơn giản về hello world
   Môi trường	Chọn môi trường triển khai proxy API.
   Quyền truy cập	Công khai
   Tự động phê duyệt 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 mục Tài nguyên API, hãy nhấp vào Thêm một 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 (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 để khách hàng có thể tìm hiểu và sử dụng API đó.

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

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 thông tin 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 thông tin.
   3. Nhấp vào Danh mục API để hiển thị trang API.
2. Nhấp vào +.
3. Chọn Hello World trong hộp thoại Add an API product to the catalog (Thêm một 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 lựa chọn sau:
   • Chọn Đã xuất bản (có 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 trong 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ả các giá trị khác theo mặc định.

5. Trong phần Tài liệu về API, để tự động tạo tài liệu tham khảo API từ một bản chụp nhanh của OpenAPI Specification (Đặc tả OpenAPI):
   1. Chọn Tài liệu OpenAPI.
   2. Nhấp vào Chọn tài liệu.
   3. Chọn thẻ My Specs (Quy cách của tôi) (nếu thẻ này chưa được chọn).
   4. Chọn helloworld trong danh sách các thông số kỹ thuật.
   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 thông tin trực tiếp để xem các thay đổi trong cổng thông tin trực tiếp (hoặc làm mới cổng thông tin trực tiếp nếu cổng này đã 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 để 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 hướng dẫn này. 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.