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 các API lên cổng thông tin của bạn để nhà phát triển ứng dụng có thể sử dụng các API đó như mô tả trong các phần sau.

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

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

Khi bạn xuất bản API lên cổng thông tin, các nội dung cập nhật sau đây sẽ tự động được thực hiện cho cổng thông tin:

  • Một 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 của Thông số OpenAPI. Nhà phát triển có thể xem tài liệu về API của bạn rồi nhấp vào 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; thì URL đó không xuất hiện trong danh sách các trang trên cổng thông tin của bạn.

  • Một đườ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 cùng với các đường liên kết đến tài liệu tham khảo API tương ứng để bạn 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; thì URL đó không xuất hiện trong danh sách các trang trên cổng thông tin của bạn.

Tổng quan nhanh về một Đặc 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 một API. Sử dụng cùng một thông số kỹ thuật ở mỗi giai đoạn trong vòng đời API, từ phát triển, xuất bản cho đến giám sát. Khi sửa đổi một 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 của mình thông qua các giai đoạn khác trong vòng đời, như mô tả trong phần Điều gì xảy ra nếu tôi sửa đổi một thông số kỹ thuật?

Khi xuất bản API, bạn sẽ lấy ảnh chụp nhanh của Thông số kỹ thuật OpenAPI để tạo tài liệu tham khảo API. Bản tổng quan nhanh đó thể hiện một phiên bản cụ thể của thông số kỹ thuật trong kho thông số kỹ thuật. Nếu bạn thay đổ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 nhanh một ảnh chụp nhanh khác về 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 của bạn

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

CORS (Chia sẻ tài nguyên trên nhiều nguồn gốc) là một cơ chế chuẩn cho phép thực thi các lệnh gọi XMLHttpRequest (XHR) của JavaScript trên trang web để tương tác với 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 và được mọi trình duyệt thực thi. Ví dụ: nếu bạn thực hiện lệnh gọi XHR đến API Twitter từ mã JavaScript thực thi trong trình duyệt, thì lệnh gọi sẽ không thực hiện được. Điều này là do miền phân phát trang cho trình duyệt của bạn không giống với miền phân phát API Twitter. CORS cung cấp giải pháp cho vấn đề này bằng cách cho phép máy chủ "chọn sử dụng" nếu họ 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 bài viết Thêm tính năng hỗ trợ CORS vào 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 đầy đủ các trình duyệt được hỗ trợ. Để xem nội dung mô tả chi tiết về CORS, hãy xem bài viết Đề xuất chia sẻ tài nguyên trên nhiều nguồn gốc W3C.

Khám phá trang API

Cách truy cập vào trang API:

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

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

Danh sách API được hiển thị.

Tài liệu tham khảo API

Như được làm nổi bật trong hình trước, trang API cho phép 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 thông tin và chọn cổng của bạn.
  2. Nhấp vào API trên trang chủ của cổng thông tin.
    Ngoài ra, bạn có thể chọn API trong trình đơn thả xuống cổng thông tin trong thanh điều hướng trên cùng.
  3. Nhấp vào + API.
    Hộp thoại Add API Product to Portal 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 để dùng cho bản tổng quan nhanh.
    Nếu bạn đã tạo proxy API có trong sản phẩm API bằng cách sử dụng thông số kỹ thuật OpenAPI, hãy chọn thông số kỹ thuật từ danh sách thả xuống.
    Thêm ảnh chụp nhanh

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

    • Không có thông số kỹ thuật và thêm thông số kỹ thuật vào lúc khác sau khi xuất bản API, như mô tả trong phần Chụp nhanh thông số kỹ thuật.
    • Chọn một thông số kỹ thuật khác để chọn hoặc tải 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 Published (Đã 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 sau, 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 của bạn.

  8. Trong Đối tượng, hãy chọn một trong các tùy chọn sau để quản lý đối tượng cho API bằng cách cho phép 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 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ạn có thể chụp nhanh bản đặc tả kỹ thuật OpenAPI mới bất kỳ lúc nào để 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.

Cách chụp nhanh thông số kỹ thuật OpenAPI:

  1. Chọn Xuất bản > Cổng thông tin và chọn cổng của bạn.
  2. Nhấp vào API trên trang chủ của cổng thông tin.
    Ngoài ra, bạn có thể chọn API trong trình đơn thả xuống cổng thông tin trong 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 thao tác.

  4. Nhấp vào Biểu tượng Tổng quan nhanh.

    Lưu ý: Một thông báo sẽ hiển thị nếu ảnh chụp nhanh hiện tại có thông số 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 lên thông số kỹ thuật mới dùng cho việc tạo tài liệu cho API. Hoặc bạn có thể chọn Không có thông số kỹ thuật để xoá thông số kỹ thuật 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à được thêm vào trang Tài liệu tham khảo API.

Xuất bản hoặc huỷ xuất bản API trên cổng thông tin của bạn

Cách xuất bản 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 thông tin và chọn cổng của bạn.
  2. Nhấp vào API trên trang chủ của cổng thông tin.
    Ngoài ra, bạn có thể chọn API trong trình đơn thả xuống cổng thông tin trong thanh điều hướng trên cùng.
  3. Định vị con trỏ trên API mà bạn muốn xuất bản hoặc huỷ xuất bản.
  4. Nhấp vào Biểu tượng cài đặt.
  5. Chọn hộp đánh dấu Đã bật để xuất bản API trên cổng thông tin của bạn. Bỏ chọn Enabled (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ý

Cách 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 thông tin và chọn cổng của bạn.
  2. Nhấp vào API trên trang chủ của cổng thông tin.
    Ngoài ra, bạn có thể chọn API trong trình đơn thả xuống cổng thông tin trong thanh điều hướng trên cùng.
  3. Di chuyển con trỏ lên API mà bạn muốn quản lý đối tượng để hiển thị các thao tác.
  4. Nhấp vào Biểu tượng cài đặt.
  5. Trong phần Đối tượng, 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 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 thông tin và chọn cổng của bạn.
  2. Nhấp vào API trên trang chủ của cổng thông tin.
    Ngoài ra, bạn có thể chọn API trong trình đơn thả xuống cổng thông tin trong 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 Xoá.

Khắc phục vấn đề liên quan đến API đã xuất bản

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

  • Đối với lỗi nội dung hỗn hợp, lỗi này có thể do một vấn đề giao diện người dùng swagger-ui đã biết gây ra. Bạn có thể giải quyết vấn đề bằng cách đả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. Ví dụ: 

     schemes:
   - https
   - http

  • Đối với các lỗi hạn chế CORS (Chia sẻ tài nguyên trê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 từ 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 proxy API. Đồng thời, hãy nhớ bật CORS trong trình duyệt của bạn.