Phát hành API (phiên bản gốc)

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

Phát hành API lên cổng thông tin của bạn để giúp nhà phát triển ứng dụng sử dụng các API đó, như được mô tả trong các phần sau.

Tổng quan về việc phát hành API

Quy trình phát hành API lên cổng thông tin của bạn gồm hai bước:

1. Chọn sản phẩm API mà bạn muốn xuất bản lên cổng thông tin của mình.
2. 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 của OpenAPI để cho phép các nhà phát triển ứng dụng tìm hiểu về các API của bạn. (Để biết thêm thông tin về ảnh chụp nhanh, hãy xem phần Tổng quan nhanh về Thông số kỹ thuật OpenAPI?

Khi bạn xuất bản API lên cổng thông tin của mình, những điểm cập nhật sau đây sẽ tự động được áp dụng cho cổng thông tin của bạn:

• Trang Tài liệu tham khảo API được thêm vào cổng thông tin của bạn
  Trang Tài liệu tham khảo API hiển thị tài liệu tham khảo API mà bạn tự động tạo từ ảnh chụp nhanh Thông số kỹ thuật OpenAPI. Nhà phát triển có thể xem tài liệu API của bạn và nhấp vào Try it (Dùng thử) để tạo yêu cầu API và xem kết quả.

  Lưu ý: Bạn không thể chỉnh sửa trực tiếp nội dung của trang này vì trang sẽ không xuất hiện trong danh sách các trang trên cổng thông tin của bạn.

  

• Đường liên kết đến trang Tài liệu tham khảo API sẽ được thêm vào trang API
  Trang API (đi kèm với cổng thông tin mẫu) cung cấp danh sách tất cả API đã xuất bản lên cổng thông tin của bạn kèm theo đường liên kết đến tài liệu tham khảo API tương ứng để biết thêm thông tin.

  Lưu ý: Bạn không thể chỉnh sửa trực tiếp nội dung của trang này vì trang sẽ không xuất hiện trong danh sách các trang trên cổng thông tin của bạn.

  

Thông tin tổng quan nhanh về Thông số kỹ thuật OpenAPI là gì?

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 ở mỗi giai đoạn trong vòng đời của API, từ phát triển đến phát hành rồi giám sát. Khi sửa đổi thông số kỹ thuật, bạn cần hiểu rõ tác động của các thay đổi đối với API thông qua các giai đoạn khác trong vòng đời, như mô tả trong bài viết Điều gì sẽ xảy ra nếu tôi sửa đổi thông số kỹ thuật?

Khi xuất bản API, bạn chụp nhanh thông tin tổng quan nhanh về Thông số kỹ thuật của OpenAPI để tạo tài liệu tham khảo API. Ảnh chụp nhanh đó đại diện cho một phiên bản cụ thể của thông số kỹ thuật trong kho lưu trữ thông số kỹ thuật. Nếu chuyển đổi Thông số kỹ thuật OpenAPI bằng trình chỉnh sửa thông số kỹ thuật, bạn có thể quyết định chụp lại ảnh chụp nhanh thông số kỹ thuật để phản ánh những thay đổi mới nhất trong tài liệu tham khảo API.

Thêm tính năng hỗ trợ CORS vào proxy API

Trước khi phát hành API, bạn cần thêm tính năng hỗ trợ CORS vào các proxy API của mình để hỗ trợ các yêu cầu trên nhiều nguồn gốc phía máy khách.

CORS (Chia sẻ tài nguyên nhiều nguồn gốc) là một cơ chế tiêu chuẩn cho phép lệnh gọi JavaScript XMLHttpRequest (XHR) được thực thi trên trang web tương tác với các tài nguyên từ các miền không phải nguồn gốc. CORS là một giải pháp thường được triển khai cho chính sách cùng nguồn gốc được thực thi bởi tất cả các trình duyệt. Ví dụ: nếu bạn thực hiện lệnh gọi XHR đến API Twitter từ việc thực thi mã JavaScript trong trình duyệt của mình, thì lệnh gọi sẽ không thành công. Điều này là do miền phân phối trang đến trình duyệt của bạn không giống với miền phân phối API Twitter. CORS cung cấp giải pháp cho vấn đề này bằng cách cho phép các máy chủ "chọn tham gia" nếu muốn cung cấp tính năng chia sẻ tài nguyên trên nhiều nguồn gốc.

Để biết thông tin về cách thêm tính năng hỗ trợ CORS vào proxy API trước khi xuất bản API, hãy xem phần Thêm hỗ trợ CORS vào một proxy API.

Lưu ý: Hầu hết các trình duyệt hiện đại đều thực thi CORS. Xem lại danh sách toàn diện các trình duyệt được hỗ trợ. Để biết nội dung mô tả chi tiết về CORS, hãy xem Đề xuất về việc chia sẻ tài nguyên W3C trên nhiều nguồn gốc.

Khám phá trang API

Để truy cập trang API:

1. Chọn Xuất bản > Cổng rồi chọn cổng thông tin của bạn.
2. Nhấp vào API trên trang chủ của cổng.

Ngoài ra, bạn có thể chọn API trong trình đơn thả xuống của cổng thông tin ở thanh điều hướng trên cùng.

Danh sách API sẽ hiển thị.

Như được đánh dấu trong hình trước, trang API cho phép bạn:

• Xem thông tin chi tiết về các API có trên cổng thông tin của bạn
• Thêm API vào cổng thông tin
• Chụp nhanh Thông số kỹ thuật OpenAPI liên kết với một sản phẩm API để cập nhật tài liệu tham khảo API
• Phát hành hoặc huỷ xuất bản API trên cổng thông tin của bạn
• Quản lý đối tượng cho một API trên cổng thông tin của bạn
• Chỉnh sửa thông số kỹ thuật liên quan (xem Tạo thông số kỹ thuật bằng trình chỉnh sửa thông số)
• Xoá API khỏi cổng thông tin
• Nhanh chóng xác định những API "mất nguồn gốc" có sản phẩm API liên kết đã bị xoá khỏi Edge và tạo lại sản phẩm API hoặc xoá API đó khỏi cổng thông tin của bạn

Thêm API vào cổng thông tin của bạn

Lưu ý: Bạn có thể thêm tối đa 100 API vào cổng thông tin của mình.

Cách thêm API vào cổng thông tin của bạn:

1. Chọn Xuất bản > Cổng rồi chọn cổng thông tin của bạn.
2. Nhấp vào API trên trang chủ của cổng.
   Ngoài ra, bạn có thể chọn API trong trình đơn thả xuống cổng thông tin ở thanh điều hướng trên cùng.
3. Nhấp vào + API.
   Hộp thoại Thêm sản phẩm API vào cổng thông tin sẽ xuất hiện.

4. Trên thẻ Sản phẩm API trong hộp thoại, hãy chọn sản phẩm API mà bạn muốn thêm vào cổng thông tin của mình.
   

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

6. Chọn nguồn để sử dụng cho ảnh chụp nhanh.
   Nếu bạn đã tạo proxy API trong sản phẩm API bằng Thông số kỹ thuật OpenAPI, hãy chọn thông số đó trong danh sách thả xuống.
   

   Ngoài ra, bạn có thể chọn:

   • Không có thông số kỹ thuật và thêm thông số vào lúc khác sau khi API được phát hành, như mô tả trong phần Tạo thông tin tổng quan nhanh về thông số kỹ thuật.
   • Chọn một thông số kỹ thuật khác để chọn hoặc tải một thông số kỹ thuật mới lên.

7. Chọn hộp đánh dấu Đã xuất bản để xuất bản API lên cổng thông tin của bạn. Bỏ chọn Đã xuất bản nếu bạn chưa sẵn sàng xuất bản API.
   Bạn có thể thay đổi chế độ cài đặt này vào lúc khác, như mô tả trong phần Xuất bản hoặc huỷ xuất bản API trên cổng thông tin.

8. Trong phần Đối tượng, hãy chọn một trong các lựa chọn sau để quản lý đối tượng cho API của bạn bằng cách cấp quyền truy cập vào:

   • Người dùng ẩn danh để cho phép tất cả người dùng xem trang.
   • Người dùng đã đăng ký để chỉ cho phép những người dùng đã đăng ký xem trang.

   Bạn có thể thay đổi chế độ cài đặt này vào lúc khác, như mô tả trong bài viết Quản lý đối tượng cho API trên cổng thông tin của bạn.

9. Nhấp vào Hoàn tất.

Chụp nhanh thông số kỹ thuật

Sau khi xuất bản API, bất cứ lúc nào bạn cũng có thể chụp nhanh thông số kỹ thuật OpenAPI để cập nhật tài liệu tham khảo API được xuất bản trên cổng thông tin của bạn.

Chụp nhanh thông số kỹ thuật OpenAPI:

1. Chọn Xuất bản > Cổng rồi chọn cổng thông tin của bạn.
2. Nhấp vào API trên trang chủ của cổng.
   Ngoài ra, bạn có thể chọn API trong trình đơn thả xuống cổng thông tin ở thanh điều hướng trên cùng.
3. Đặt con trỏ lên API mà bạn muốn chụp nhanh để hiển thị các hành động.

4. Nhấp vào .

   Lưu ý: Một thông báo sẽ xuất hiện nếu thông tin tổng quan nhanh mới nhất với thông số kỹ thuật nguồn đã chọn.

5. Chọn thông số kỹ thuật hiện có từ trình đơn thả xuống Nguồn ảnh chụp nhanh hoặc chọn Chọn thông số kỹ thuật khác để chọn hoặc tải thông số kỹ thuật mới lên để tạo tài liệu cho API. Ngoài ra, bạn có thể chọn Không có thông số kỹ thuật để xoá quy cách hiện tại.

6. Nhấp vào Cập nhật ảnh chụp nhanh (hoặc Xoá ảnh chụp nhanh, nếu bạn đã chọn Không có thông số kỹ thuật).

Tài liệu tham khảo API được tạo từ quy cách và thêm vào trang Tài liệu tham khảo API.

Phát hành hoặc huỷ xuất bản API trên cổng thông tin của bạn

Cách phát hành hoặc huỷ xuất bản API trên cổng thông tin của bạn:

1. Chọn Xuất bản > Cổng rồi chọn cổng thông tin của bạn.
2. Nhấp vào API trên trang chủ của cổng.
   Ngoài ra, bạn có thể chọn API trong trình đơn thả xuống cổng thông tin ở thanh điều hướng trên cùng.
3. Đặt con trỏ lên API mà bạn muốn xuất bản hoặc huỷ xuất bản.
4. Nhấp vào .
5. Chọn hộp đánh dấu Đã bật để phát hành API trên cổng thông tin của bạn. Bỏ chọn Đã bật để huỷ xuất bản API.
6. Nhấp vào Lưu.

Quản lý đối tượng cho API trên cổng thông tin của bạn

Quản lý đối tượng cho API trên cổng thông tin của bạn bằng cách cấp quyền truy cập vào:

• Tất cả người dùng
• Chỉ người dùng đã đăng ký

Để quản lý đối tượng cho API trên cổng thông tin của bạn:

1. Chọn Xuất bản > Cổng rồi chọn cổng thông tin của bạn.
2. Nhấp vào API trên trang chủ của cổng.
   Ngoài ra, bạn có thể chọn API trong trình đơn thả xuống cổng thông tin ở thanh điều hướng trên cùng.
3. Đặt con trỏ lên API mà bạn muốn quản lý đối tượng để hiển thị các hành động.
4. Nhấp vào .
5. Trong phần Đối tượng người xem, hãy chọn một trong các lựa chọn sau:
   • Người dùng ẩn danh để cho phép tất cả người dùng xem sản phẩm API.
   • Người dùng đã đăng ký để chỉ cho phép những người dùng đã đăng ký xem sản phẩm API.
6. Nhấp vào Lưu.

Xoá API khỏi cổng thông tin của bạn

Cách xoá API khỏi cổng thông tin của bạn:

1. Chọn Xuất bản > Cổng rồi chọn cổng thông tin của bạn.
2. Nhấp vào API trên trang chủ của cổng.
   Ngoài ra, bạn có thể chọn API trong trình đơn thả xuống cổng thông tin ở thanh điều hướng trên cùng.
3. Đặt con trỏ lên API trong danh sách để hiển thị trình đơn thao tác.
4. Nhấp vào .

Khắc phục vấn đề liên quan đến các API đã phát hành

Khi sử dụng tính năng Dùng thử, nếu lỗi TypeError: Failed to fetch được trả về, hãy xem xét các nguyên nhân có thể xảy ra và cách giải quyết sau:

• Đối với lỗi nội dung hỗn hợp, lỗi có thể do vấn đề đã biết về giao diện người dùng swagger-ui. Một giải pháp có thể là đảm bảo rằng bạn chỉ định HTTPS trước HTTP trong định nghĩa schemes trong Thông số kỹ thuật OpenAPI của bạn. Ví dụ:

   schemes:
     - https
     - http
  

• Đối với các lỗi hạn chế CORS (Chia sẻ tài nguyên nhiều nguồn gốc), hãy đảm bảo rằng CORS được hỗ trợ cho các proxy API của bạn. CORS là một cơ chế tiêu chuẩn cho phép các yêu cầu nhiều nguồn gốc phía máy khách. Xem phần Thêm tính năng hỗ trợ CORS cho một proxy API. Hãy đảm bảo bạn cũng bật CORS trong trình duyệt.