Phát hành API

Bạn đang xem tài liệu về Apigee Edge.
Hãy xem tài liệu về Apigee X.

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

Tổng quan về việc xuất bản API

Quy trình phát hành 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. Kết xuất tài liệu tham khảo API từ ảnh chụp nhanh của tài liệu OpenAPI hoặc giản đồ GraphQL để 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 phần Ảnh chụp nhanh là gì?)

Nội dung nào được xuất bản lên cổng thông tin?

Khi bạn phát hành API, các nội dung cập nhật sau đây sẽ được tự động thực hiện cho cổng thông tin của bạn:
  • Tài liệu tham khảo API. Giao diện được cung cấp phụ thuộc vào việc bạn phát hành API bằng tài liệu OpenAPI hay giản đồ GraphQL. Xem:
  • Liên kết đến trang tham chiếu API được thêm vào trang API

    Trang API (đi kèm với cổng mẫu) cung cấp danh sách tất cả các API được xuất bản cho cổng của bạn, được liệt kê theo thứ tự bảng chữ cái, với liên kết đến tài liệu tham khảo API tương ứng để biết thêm thông tin. Nếu muốn, bạn có thể tuỳ chỉnh các mục sau:

    • Hình ảnh hiển thị của từng thẻ API
    • Danh mục dùng để gắn thẻ API cho phép nhà phát triển khám phá các API liên quan trên trang API

    Trang API trong cổng trực tiếp hiển thị hai danh mục và việc sử dụng hình ảnh

    • SmartDocs (OpenAPI)

    Khi bạn phát hành API bằng tài liệu OpenAPI, tài liệu tham khảo của API SmartDocs sẽ được thêm vào cổng thông tin của bạn.

    Nhà phát triển có thể xem lại tài liệu tham khảo API SmartDocs của bạn và sử dụng bảng điều khiển Thử API này để đưa ra yêu cầu API và xem kết quả. Hãy thử API này hoạt động với các điểm cuối không bảo mật hoặc các điểm cuối bảo mật bằng cách sử dụng Cơ bản, Khóa API hoặc Xác thực OAuth dựa trên phương thức bảo mật được xác định trong tài liệu OpenAPI của bạn. Đối với OAuth, các luồng sau được hỗ trợ: mã ủy quyền, mật khẩu và thông tin đăng nhập của ứng dụng.

    Trang tài liệu tham khảo API có chú thích cho biết cách cấp phép cho lệnh gọi API, hủy gắn bảng Thử API này, tải xuống thông số có liên quan và thực thi API.

    Nhấp vào để mở rộng bảng điều khiển Thử API này. Bảng điều khiển mở rộng cho phép bạn xem các mẫu mã và cuộc gọi curl ở nhiều định dạng khác nhau, chẳng hạn như HTTP, Python, Node.js và nhiều định dạng khác, như được hiển thị bên dưới.

    Đã mở rộng Thử bảng điều khiển API này

    Trình khám phá GraphQL

    Khi bạn phát hành API bằng giản đồ GraphQL, GraphQL Explorer được thêm vào cổng của bạn. GraphQL Explorer là một sân chơi tương tác để chạy các truy vấn dựa trên API của bạn. Trình khám phá dựa trên GraphiQL, cách triển khai tham chiếu của GraphQL IDE do GraphQL Foundation phát triển.

    Nhà phát triển có thể sử dụng GraphQL Explorer để khám phá tài liệu tương tác dựa trên giản đồ, xây dựng và chạy truy vấn, xem kết quả truy vấn và tải xuống lược đồ. Để bảo mật quyền truy cập vào API của bạn, nhà phát triển có thể chuyển tiêu đề ủy quyền trong ngăn Yêu cầu tiêu đề.

    Để biết thêm thông tin về GraphQL, vui lòng xem graphql.org.

    Trình khám phá GraphQL trong cổng

    Ảnh chụp nhanh là gì?

    Mỗi tài liệu OpenAPI hoặc GraphQL đóng vai trò là nguồn đáng tin trong suốt vòng đời của một API. Tài liệu được sử dụng ở mỗi giai đoạn trong vòng đời của API, từ phát triển đến xuất bản để theo dõi. Khi sửa đổi một tài liệu, bạn cần phải nhận thức được tác động của những 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 tài liệu?

    Khi phát hành API, bạn cần chụp ảnh chụp nhanh của tài liệu OpenAPI hoặc GraphQL để kết xuất tài liệu tham chiếu API. Ảnh chụp nhanh thể hiện phiên bản cụ thể của tài liệu. Nếu bạn sửa đổi tài liệu, bạn có thể quyết định chụp một ảnh chụp nhanh khác của tài liệu để phản ánh những thay đổi mới nhất trong tài liệu tham khảo API.

    Giới thiệu về URL gọi lại

    Nếu ứng dụng của bạn yêu cầu URL gọi lại, chẳng hạn như khi sử dụng loại cấp quyền mã ủy quyền OAuth 2.0 (thường được gọi là "OAuth thành phần"), bạn có thể yêu cầu nhà phát triển chỉ định URL gọi lại khi họ đăng ký ứng dụng của họ. URL gọi lại thường chỉ định URL của một ứng dụng được chỉ định để nhận mã ủy quyền thay mặt cho ứng dụng khách. Để biết thêm thông tin, hãy xem Triển khai loại cấp quyền mã ủy quyền.

    Bạn có thể định cấu hình xem có yêu cầu URL gọi lại trong khi đăng ký ứng dụng hay không khi thêm API vào cổng của mình. Bạn có thể sửa đổi cài đặt này bất kỳ lúc nào, như được mô tả trong Quản lý URL gọi lại cho API.

    Khi đăng ký ứng dụng, nhà phát triển phải nhập URL gọi lại cho tất cả API yêu cầu, như được mô tả trong Đăng ký ứng dụng.

    Định cấu hình proxy API của bạn để hỗ trợ "Thử API này"

    Trước khi xuất bản API bằng tài liệu OpenAPI, bạn cần định cấu hình proxy API để hỗ trợ đưa ra yêu cầu trên bảng điều khiển Thử API này trong tài liệu tham khảo API SmartDocs như sau:

    • Thêm tính năng hỗ trợ CORS vào proxy API để thực thi các yêu cầu từ nhiều nguồn gốc phía máy khách

      CORS là cơ chế chuẩn cho phép các lệnh gọi JavaScript XMLHttpRequest (XHR) được thực thi 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 "cùng một chính sách nguồn gốc" được tất cả các trình duyệt thực thi.

    • Cập nhật cấu hình proxy API của bạn nếu bạn đang sử dụng xác thực cơ bản hoặc OAuth2

    Bảng sau đây tóm tắt các yêu cầu về cấu hình proxy API để hỗ trợ bảng điều khiển Thử API này trong tài liệu tham khảo API SmartDocs dựa trên quyền truy cập xác thực.

    Quyền truy cập xác thực Yêu cầu về cấu hình chính sách
    Không có hoặc khóa API Thêm tính năng hỗ trợ CORS vào proxy API. Để thuận tiện, hãy sử dụng giải pháp CORS mẫu được cung cấp trên GitHub hoặc làm theo các bước trong bài viết Thêm tuỳ chọn hỗ trợ CORS vào proxy API.
    Xác thực cơ bản Thực hiện các bước sau:
    1. Thêm tính năng hỗ trợ CORS vào proxy API. Để thuận tiện, hãy sử dụng giải pháp CORS mẫu được cung cấp trên GitHub hoặc làm theo các bước trong bài viết Thêm tuỳ chọn hỗ trợ CORS vào proxy API.
    2. Trong chính sách Thêm CORS CORSMessage, hãy đảm bảo tiêu đề Access-Control-Allow-Headers bao gồm thuộc tính authorization. Ví dụ: 
      <Header name="Access-Control-Allow-Headers">
  origin, x-requested-with, accept, content-type, authorization
</Header>
    OAuth2
    1. Thêm tính năng hỗ trợ CORS vào proxy API. Để thuận tiện, hãy sử dụng giải pháp CORS mẫu được cung cấp trên GitHub hoặc làm theo các bước trong bài viết Thêm tuỳ chọn hỗ trợ CORS vào proxy API.
    2. Trong chính sách Thêm CORS CORSMessage, hãy đảm bảo tiêu đề Access-Control-Allow-Headers bao gồm thuộc tính authorization. Ví dụ: 
      <Header name="Access-Control-Allow-Headers">
  origin, x-requested-with, accept, content-type, authorization
</Header>
    3. Sửa hành vi không tuân thủ RFC trong chính sách OAuth2 của bạn. Để thuận tiện, hãy sử dụng giải pháp OAuth2 mẫu có trên GitHub hoặc thực hiện các bước sau:
      • Đảm bảo rằng phần tử <GrantType> trong chính sách OAuth2 được đặt thành request.formparam.grant_type (thông số biểu mẫu). Để biết thêm thông tin, hãy xem <GrantType>.
      • Đảm bảo rằng token_type trong chính sách OAuth2 được đặt thành Bearer chứ không phải BearerToken mặc định.

    Khám phá danh mục API

    Cách xem danh mục API:
    1. Chọn Xuất bản > Cổng và chọn cổng của bạn.
    2. Nhấp vào Danh mục API trên trang chủ của cổng thông tin.
    Ngoài ra, bạn có thể chọn danh mục API trong trình đơn thả xuống của cổng thông tin trên thanh điều hướng ở trên cùng.

    Thẻ API trong danh mục API cho thấy danh sách API đã được thêm vào cổng thông tin của bạn.

    Tab API hiển thị thông tin về các API bao gồm tên, mô tả, chế độ hiển thị, danh mục, thông số kỹ thuật được liên kết và thời gian được sửa đổi

    Như đã nêu bật trong hình trước, tab API cho phép bạn:

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

    Cách thêm API vào cổng thông tin:

    1. Truy cập danh mục API.
    2. Nhấp vào thẻ API, nếu chưa chọn.

    3. Nhấp vào +.

      Sản phẩm Add a API (Thêm sản phẩm API) vào hộp thoại danh mục sẽ xuất hiện.

    4. 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.
      Trang chi tiết API sẽ hiển thị.

    6. Định cấu hình nội dung tài liệu tham chiếu API và mức độ hiển thị của nội dung đó trên cổng thông tin:

      Trường Mô tả
      Đã xuất bảnChọn Đã xuất bản để xuất bản API lên cổng của bạn. Bỏ chọn hộp kiểm nếu bạn chưa sẵn sàng xuất bản API. Bạn có thể thay đổi cài đặt sau, như được mô tả trong Xuất bản hoặc hủy xuất bản API trên cổng của bạn.
      Hiển thị tiêu đề Cập nhật tiêu đề của API hiển thị trong danh mục. Theo mặc định, tên sản phẩm API được sử dụng. Bạn có thể thay đổi tiêu đề hiển thị sau, như mô tả trong Chỉnh sửa tiêu đề và mô tả hiển thị.
      Hiển thị mô tả Cập nhật mô tả API của bạn được hiển thị trong danh mục. Theo mặc định, mô tả sản phẩm API được sử dụng. Bạn có thể thay đổi mô tả hiển thị sau, như được mô tả trong Chỉnh sửa tiêu đề và mô tả hiển thị.
      Yêu cầu nhà phát triển chỉ định URL gọi lạiBật nếu bạn muốn yêu cầu nhà phát triển ứng dụng chỉ định URL gọi lại. Bạn có thể thêm hoặc cập nhật URL gọi lại sau, như mô tả trong Quản lý URL gọi lại cho API.
      Tài liệu API Cách sử dụng tài liệu OpenAPI:
      1. Chọn Tài liệu OpenAPI.
      2. Nhấp vào Chọn tài liệu.
      3. Thực hiện một trong các bước sau:
        • Nhấp vào tab Thông số kỹ thuật của tôi và chọn thông số kỹ thuật từ cửa hàng thông số kỹ thuật.
        • Nhấp vào tab Tải lên tệp và tải lên tệp.
        • Nhấp vào tab Nhập từ URL và nhập thông số kỹ thuật từ URL.
      4. Nhấp vào Chọn.

      Cách sử dụng giản đồ GraphQL:

      1. Chọn Giản đồ GraphQL.
      2. Nhấp vào Chọn tài liệu.
      3. Điều hướng đến và chọn giản đồ GraphQL.
      4. Nhấp vào Chọn.

      Ngoài ra, bạn có thể chọn Không có tài liệu rồi thêm một tài liệu vào lúc khác sau khi thêm API, theo mô tả trong phần Quản lý ảnh chụp nhanh của tài liệu.

      Chế độ hiển thị API

      Nếu bạn chưa đăng ký bản phát hành beta của tính năng quản lý đối tượng, hãy chọn một trong các tùy chọn sau:

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

      Nếu bạn đã đăng ký bản phát hành beta của tính năng quản lý đối tượng, hãy chọn một trong các tùy chọn sau:

      • Công khai (hiển thị với mọi người) để cho phép tất cả người dùng xem API.
      • Người dùng đã xác thực để chỉ cho phép người dùng đã đăng ký xem API.
      • Đối tượng được chọn để chọn đối tượng cụ thể bạn muốn có thể xem API.

      Bạn có thể quản lý chế độ hiển thị của đối tượng vào lúc khác, như được mô tả trong bài viết Quản lý chế độ hiển thị của API trong cổng của bạn.

      Hình ảnh hiển thị Để hiện hình ảnh trên thẻ API trên trang API, hãy nhấp vào Chọn hình ảnh. Trong hộp thoại Chọn hình ảnh, hãy chọn hình ảnh hiện có, tải hình ảnh mới lên hoặc cung cấp URL của hình ảnh bên ngoài rồi nhấp vào Chọn. Xem trước hình thu nhỏ API và nhấp vào Chọn. Bạn có thể thêm một hình ảnh sau, như mô tả trong Quản lý hình ảnh cho thẻ API.
      Danh mục

      Thêm các danh mục mà API sẽ được gắn thẻ để cho phép nhà phát triển ứng dụng khám phá các API liên quan trên trang API. Để xác định danh mục:

      • Chọn danh mục từ danh sách thả xuống.
      • Thêm danh mục mới bằng cách nhập tên của danh mục và nhấn Enter. Danh mục mới sẽ được thêm vào trang Danh mục và được cung cấp khi thêm hoặc chỉnh sửa các API khác.

    7. Nhấp vào Lưu.

    Quản lý ảnh chụp nhanh của tài liệu

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

    Để quản lý ảnh chụp nhanh của tài liệu:

    1. Truy cập danh mục API.
    2. Nhấp vào thẻ API, nếu chưa chọn.
    3. Nhấp vào hàng của API mà bạn muốn chỉnh sửa.
    4. Kiểm tra trạng thái ảnh chụp nhanh. Nếu thông tin này đã cũ, thì thông báo sau sẽ hiển thị:
      Biểu tượng và thông báo cho biết ảnh chụp nhanh đã lỗi thời
    5. Nhấp vào biểu tượng chỉnh sửa.
    6. Thực hiện một trong các tác vụ sau:
      • Để làm mới ảnh chụp nhanh của tài liệu OpenAPI đã lỗi thời, hãy nhấp vào Làm mới ảnh chụp nhanh.
      • Để thay đổi tài liệu dùng để tạo tài liệu cho API, trong tài liệu API, hãy nhấp vào Chọn tài liệu rồi chọn tài liệu mới.
    7. Nhấp vào Lưu.

    Tài liệu tham chiếu API được hiển thị từ tài liệu và được thêm vào trang Tham chiếu API. Trạng thái ảnh chụp nhanh được cập nhật thành hiện tại:

    Biểu tượng và thông báo cho biết ảnh chụp nhanh là hiện thời

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

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

    1. Truy cập danh mục API.
    2. Nhấp vào thẻ API, nếu chưa chọn.
    3. Nhấp vào hàng của API mà bạn muốn chỉnh sửa.
    4. Nhấp vào Biểu tượng chỉnh sửa.
    5. Trong phần chi tiết API, chọn hoặc bỏ chọn Đã xuất bản (được liệt kê trong danh mục) để xuất bản hoặc hủy xuất bản API trên cổng của bạn tương ứng.
    6. Nhấp vào Lưu.

    Quản lý khả năng hiển thị của API trong cổng thông tin của bạn

    Quản lý khả năng hiển thị của API trong cổng thông tin của bạn bằng cách cho phép truy cập:

    Cách quản lý chế độ hiển thị của API trong cổng thông tin:

    1. Truy cập danh mục API.
    2. Nhấp vào thẻ API, nếu chưa chọn.
    3. Nhấp vào hàng của API mà bạn muốn chỉnh sửa.
    4. Nhấp vào Biểu tượng chỉnh sửa.
    5. Trong chế độ hiển thị API, chọn một trong các tùy chọn sau:

    6. Chọn chế độ hiển thị. Nếu bạn đã đăng ký bản phát hành beta của tính năng đối tượng, hãy chọn một trong các tùy chọn sau:

      • Công khai (hiển thị với mọi người) để cho phép tất cả người dùng xem trang.
      • Người dùng đã xác thực để chỉ cho phép người dùng đã đăng ký xem trang.
      • Đối tượng được chọn để chọn đối tượng cụ thể bạn muốn có thể xem trang. Xem Quản lý đối tượng cho cổng của bạn.
      Nếu khô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 trang.
      • Người dùng đã đăng ký để chỉ cho phép người dùng đã đăng ký xem trang.

    7. Nhấp vào Gửi.

    Quản lý URL gọi lại cho API

    Quản lý URL gọi lại cho API. Hãy xem bài viết Giới thiệu về URL gọi lại.

    Để quản lý URL gọi lại cho API:

    1. Truy cập danh mục API.
    2. Nhấp vào thẻ API, nếu chưa chọn.
    3. Nhấp vào hàng của API mà bạn muốn chỉnh sửa.
    4. Nhấp vào Biểu tượng chỉnh sửa.
    5. Trong phần chi tiết API, chọn hoặc bỏ chọn Đã xuất bản (được liệt kê trong danh mục) để xuất bản hoặc hủy xuất bản API trên cổng của bạn tương ứng.
    6. Nhấp vào Lưu.

    Quản lý hình ảnh cho một thẻ API

    Quản lý hình ảnh xuất hiện cùng với thẻ API trên trang API bằng cách thêm hoặc thay đổi hình ảnh hiện tại.

    Cách quản lý hình ảnh cho một thẻ API:

    1. Truy cập danh mục API.
    2. Nhấp vào thẻ API, nếu chưa chọn.
    3. Nhấp vào hàng của API mà bạn muốn chỉnh sửa.
    4. Nhấp vào Biểu tượng chỉnh sửa.

    5. Trong chi tiết API:

      • Nhấp vào Chọn hình ảnh để chọn hoặc tải hình ảnh lên nếu hiện chưa có hình ảnh nào được chọn.
      • Nhấp vào Thay đổi hình ảnh để chọn hoặc tải hình ảnh khác lên.
      • Nhấp vào dấu x trong hình ảnh để xóa hình ảnh đó.

    6. Nhấp vào Lưu.

    Gắn thẻ API bằng danh mục

    Gắn thẻ API bằng các danh mục theo một trong các cách sau:

    • Quản lý các danh mục mà API được gắn thẻ khi chỉnh sửa API, như được mô tả bên dưới.
    • Quản lý các API được gắn thẻ cho một danh mục khi chỉnh sửa danh mục đó.

    Cách gắn thẻ API cho các danh mục khi chỉnh sửa API:

    1. Truy cập danh mục API.
    2. Nhấp vào thẻ API, nếu chưa chọn.
    3. Nhấp vào hàng của API mà bạn muốn chỉnh sửa.
    4. Nhấp vào Biểu tượng chỉnh sửa.
    5. Nhấp vào trường Danh mục rồi thực hiện một trong các bước sau:
      • Chọn danh mục từ danh sách thả xuống.
      • Thêm danh mục mới bằng cách nhập tên của danh mục và nhấn Enter. Danh mục mới sẽ được thêm vào trang Danh mục và được cung cấp khi thêm hoặc chỉnh sửa các API khác.
    6. Lặp lại việc gắn thẻ API cho các danh mục khác.
    7. Nhấp vào Lưu.

    Chỉnh sửa tiêu đề và mô tả hiển thị

    Để chỉnh sửa tiêu đề và mô tả hiển thị:

    1. Truy cập danh mục API.
    2. Nhấp vào thẻ API, nếu chưa chọn.
    3. Nhấp vào hàng của API mà bạn muốn chỉnh sửa.
    4. Nhấp vào Biểu tượng chỉnh sửa.
    5. Chỉnh sửa các trường Tiêu đề hiển thị và Nội dung mô tả hiển thị theo yêu cầu.
    6. Nhấp vào Lưu.

    Xóa API khỏi cổng thông tin

    Cách xóa API khỏi cổng thông tin:

    1. Truy cập danh mục API.
    2. Chọn API, nếu chưa được chọn.
    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 Biểu tượng chỉnh sửa.

    Quản lý các danh mục dùng để khám phá các API liên quan

    Gắn thẻ API bằng danh mục để cho phép nhà phát triển ứng dụng khám phá các API liên quan trên trang API của cổng thông tin đang hoạt động. Thêm và quản lý các danh mục, như được mô tả trong các phần sau.

    Khám phá trang Danh mục

    Để xem trang Danh mục:

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

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

    3. Nhấp vào thẻ Danh mục.

    Tab Danh mục trong danh mục API hiển thị danh sách các danh mục đã được xác định cho cổng của bạn.

    Tab Danh mục hiển thị tên danh mục, tên và tổng số API được chỉ định

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

    Thêm danh mục

    Thêm danh mục theo một trong các cách sau:

    • Nhập tên danh mục khi thêm API vào cổng
    • Thêm danh mục theo cách thủ công như được mô tả bên dưới

    Danh mục mới sẽ được thêm vào trang Danh mục và được cung cấp khi thêm hoặc chỉnh sửa các API khác.

    Để thêm danh mục theo cách thủ công:

    1. Truy cập trang Danh mục.
    2. Nhấp vào +.
    3. Nhập tên danh mục mới của bạn.
    4. Chọn một hoặc nhiều API để gắn thẻ vào danh mục (không bắt buộc).
    5. Nhấp vào Tạo.

    Chỉnh sửa danh mục

    Để chỉnh sửa danh mục:

    1. Truy cập trang Danh mục.
    2. Nhấp vào .
    3. Chỉnh sửa tên danh mục.
    4. Thêm hoặc xóa thẻ API.
    5. Nhấp vào Lưu.

    Xóa danh mục

    Khi bạn xóa một danh mục, tất cả các thẻ API cho danh mục đó cũng sẽ bị xóa.

    Để xóa danh mục:

    1. Truy cập trang Danh mục.
    2. Đặt con trỏ trên danh mục bạn muốn chỉnh sửa để hiển thị menu tác vụ.
    3. Nhấp vào .
    4. Chỉnh sửa tên danh mục.
    5. Thêm hoặc xoá API.
    6. Nhấp vào Lưu.

    Khắc phục sự cố với các API đã xuất bản

    Các phần sau đây cung cấp thông tin giúp bạn khắc phục lỗi cụ thể đối với các API đã xuất bản của chúng tôi.

    Lỗi: Không thể tìm nạp lỗi được trả về khi sử dụng Thử API này

    Khi dùng thử API này, nếu lỗi TypeError: Failed to fetch được trả về, hãy cân nhắc những nguyên nhân và cách giải quyết sau đây:

    • Đối với các lỗi nội dung hỗn hợp, lỗi này có thể do vấn đề swagger-ui đã biết gây ra. Một giải pháp có thể có là đảm bảo rằng bạn chỉ định HTTPS trước HTTP trong định nghĩa schemes trong tài liệu OpenAPI của mình. Ví dụ:

      schemes:
   - https
   - http

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

    Lỗi: Tiêu đề 'Access-Control-Allow-Origin' chứa nhiều giá trị '*, *', nhưng chỉ cho phép một giá trị

    Khi sử dụng Thử API này, bạn có thể nhận được thông báo lỗi sau nếu tiêu đề Access-Control-Allow-Origin đã tồn tại:

    The 'Access-Control-Allow-Origin' header contains multiple values '*, *', but only one is allowed.

    Để khắc phục lỗi này, hãy sửa đổi chính sáchassignMessage để sử dụng <Set> nhằm đặt tiêu đề CORS thay vì <Add>, như minh hoạ trong đoạn trích bên dưới. Để biết thêm thông tin, hãy xem bài viết liên quan đến cộng đồng. 

    <AssignMessage async="false" continueOnError="false" enabled="true" name="add-cors">
    <DisplayName>Add CORS</DisplayName>
    <FaultRules/>
    <Properties/>
    <Set>
        <Headers>
            <Header name="Access-Control-Allow-Origin">{request.header.origin}</Header>
            <Header name="Access-Control-Allow-Headers">origin, x-requested-with, accept, content-type, authorization</Header>
            <Header name="Access-Control-Max-Age">3628800</Header>
            <Header name="Access-Control-Allow-Methods">GET, PUT, POST, DELETE</Header>
        </Headers>
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

    Lỗi: Không được phép yêu cầu trường tiêu đề

    Khi dùng thử API này, nếu gặp lỗi Request header field not allowed, tương tự như ví dụ bên dưới, thì bạn có thể phải cập nhật các tiêu đề được hỗ trợ trong chính sách CORS. Ví dụ:

    Access to XMLHttpRequest ... has been blocked by CORS policy: Request header field
content-type is not allowed by Access-Control-Allow-Headers in preflight response

    Trong ví dụ này, bạn cần thêm tiêu đề content-type vào mục Access-Control-Allow-Headers trong chính sách CORSẤnMessageMessage, như mô tả trong bài viết Đính kèm chính sách Thêm CORS vào proxy API mới.

    Lỗi: Quyền truy cập bị từ chối khi gọi proxy API bằng OAuth2

    Chính sách OAuthV2 của Apigee trả về phản hồi mã thông báo chứa một số thuộc tính không tuân thủ RFC. Ví dụ: chính sách này sẽ trả về một mã thông báo có giá trị BearerToken, thay vì giá trị Bearer tương đương như dự kiến. Phản hồi token_type không hợp lệ này có thể gây ra lỗi Access denied khi sử dụng Thử API này.

    Để khắc phục vấn đề này, bạn có thể tạo chính sách JavaScript hoặcassignMessage để chuyển đổi đầu ra của chính sách thành định dạng tuân thủ. Để biết thêm thông tin, hãy xem hành vi không tuân thủ RFC.