Phát hành 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

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 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 phát hành cho cổng thông tin của mình.
  2. Tài liệu tham khảo API kết xuất từ thông tin tổng quan nhanh về 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 bài viết Tổng quan nhanh là gì?)

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

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

    Trang API (có trong cổng thông tin mẫu) cung cấp danh sách tất cả API được phát hành cho cổng thông tin của bạn, được liệt kê theo thứ tự bảng chữ cái, cùng với đường 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 những nội dung sau:

    • Hình ảnh hiển thị cho mỗi thẻ API
    • Các danh mục dùng để gắn thẻ API để nhà phát triển có thể khám phá các API có liên quan trên trang API

    Trang API trong cổng thông tin trực tiếp cho thấy hai danh mục và cách sử dụng hình ảnh

    • SmartDocs (OpenAPI)

    Khi bạn phát hành một API bằng tài liệu OpenAPI, tài liệu tham khảo 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 tài liệu tham khảo API SmartDocs và sử dụng bảng điều khiển Try this API (Thử API này) để tạo yêu cầu API và xem kết quả. Hãy thử API này với các điểm cuối không bảo mật hoặc điểm cuối bảo mật bằng phương thức Xác thực cơ bản, Khoá API hoặc OAuth, dựa trên phương thức bảo mật được xác định trong tài liệu OpenAPI. Đối với OAuth, các luồng sau đây được hỗ trợ: mã uỷ quyền, mật khẩu và thông tin xác thực ứng dụng khách.

    Trang tài liệu tham khảo API có các chú thích cho biết cách uỷ quyền lệnh gọi API, huỷ gắn bảng điều khiển Thử dùng API này, tải thông số kỹ thuật có liên quan xuống rồi thực thi API.

    Nhấp vào để mở rộng bảng điều khiển Dùng thử API này. Bảng điều khiển mở rộng cho phép bạn xem lệnh gọi curl và mã mẫu ở nhiều định dạng, chẳng hạn như HTTP, Python, Node.js, v.v., như minh hoạ dưới đây.

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

    Trình khám phá GraphQL

    Khi bạn xuất bản một API bằng giản đồ GraphQL, Trình khám phá GraphQL sẽ đượ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. Trình khám phá này dựa trên GraphiQL, một phương thức triển khai tham chiếu của IDE GraphQL do GraphQL Foundation phát triển.

    Các 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 đồ, tạo và chạy truy vấn, xem kết quả truy vấn và tải giản đồ xuống. Để bảo mật quyền truy cập vào API, nhà phát triển có thể truyền các tiêu đề uỷ quyền trong ngăn Request Headers (Tiêu đề yêu cầu).

    Để biết thêm thông tin về GraphQL, hãy truy cập vào graphql.org.

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

    Ảnh chụp nhanh là gì?

    Mỗi tài liệu OpenAPI hoặc GraphQL đóng vai trò là nguồn đáng tin cậy trong suốt vòng đời của API. Sử dụng cùng một tài liệu ở 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 tài liệu, bạn cần hiểu rõ 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 xuất bản API, bạn sẽ 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 khảo API. Bản tổng quan nhanh đó cho thấy một phiên bản cụ thể của tài liệu. Nếu sửa đổi tài liệu, bạn có thể quyết định chụp lại ảnh chụp nhanh 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 mã uỷ quyền OAuth 2.0 (thường được gọi là "OAuth ba bê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. URL gọi lại thường chỉ định URL của ứ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 phần Triển khai loại cấp mã uỷ quyền.

    Bạn có thể định cấu hình việc có yêu cầu URL gọi lại trong quá trình đăng ký ứng dụng hay không khi thêm API vào cổng thông tin. Bạn có thể sửa đổi chế độ cài đặt này bất cứ lúc nào, như mô tả trong bài viết 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 URL đó, như mô tả trong phần Đăng ký ứng dụng.

    Định cấu hình proxy API để hỗ trợ tính năng "Dùng thử API này"

    Trước khi phát hành API bằng tài liệu OpenAPI, bạn cần định cấu hình proxy API để hỗ trợ tạo yêu cầu trên bảng điều khiển Try this API (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 chéo nguồn gốc phía máy khách

      CORS 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" mà tất cả trình duyệt đều thực thi.

    • Cập nhật cấu hình proxy API nếu bạn đang sử dụng phương thức 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 khoá 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 được mô tả trong phần Thêm tính năng 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 của bạn. Để 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 được mô tả trong phần Thêm tính năng hỗ trợ CORS vào proxy API.
    2. Trong chính sách Thêm CORS miễn phí, 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 của bạn. Để 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 được mô tả trong bài viết Thêm tính năng hỗ trợ CORS vào proxy API.
    2. Trong chính sách Thêm CORS miễn phí, 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. Khắc phục hành vi không tuân thủ RFC trong chính sách OAuth2. Để thuận tiện, hãy sử dụng giải pháp OAuth2 mẫu được cung cấp trên GitHub hoặc thực hiện các bước sau:
      • Đảm bảo rằng bạn đặt phần tử <GrantType> trong chính sách OAuth2 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 thông tin 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 thông tin trong thanh điều hướng trên cùng.

    Thẻ API trong danh mục API hiển thị danh sách những API đã được thêm vào cổng thông tin của bạn.

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

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

    Thêm API vào cổng thông tin

    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 được chọn.

    3. Nhấp vào +.

      Hộp thoại Thêm một sản phẩm API vào 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ẽ xuất hiện.

    6. Định cấu hình nội dung tài liệu tham khảo API và chế độ hiển thị của tài liệu đó 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 thông tin của bạn. Bỏ chọn hộp đánh dấu nếu bạn chưa sẵn sàng phát hành API. Bạn có thể thay đổi chế độ cài đặt này sau, như mô tả trong bài viết Xuất bản hoặc huỷ xuất bản API trên cổng thông tin.
      Tiêu đề hiển thị Cập nhật tiêu đề của API đang hiển thị trong danh mục. Theo mặc định, tên sản phẩm API sẽ được sử dụng. Bạn có thể thay đổi tiêu đề hiển thị sau, như mô tả trong phần Chỉnh sửa tiêu đề hiển thị và nội dung mô tả.
      Nội dung mô tả hiển thị Cập nhật nội dung mô tả của API đang hiển thị trong danh mục. Theo mặc định, nội dung mô tả sản phẩm API sẽ được sử dụng. Bạn có thể thay đổi nội dung mô tả hiển thị vào lúc khác, như mô tả trong phần Chỉnh sửa tiêu đề hiển thị và nội dung mô tả.
      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 một 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 phần 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 thẻ Thông số kỹ thuật của tôi rồi chọn một thông số kỹ thuật trong cửa hàng thông số kỹ thuật.
        • Nhấp vào thẻ Tải tệp lên rồi tải tệp lên.
        • Nhấp vào thẻ Nhập từ URL rồi 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. Chuyển đế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 tài liệu sau khi thêm API, như 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ý sử dụng 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 lựa 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ý sử dụng 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 lựa chọn sau:

      • Công khai (mọi người đều có thể xem) để 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 những đối tượng cụ thể mà 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ư mô tả trong bài viết Quản lý chế độ hiển thị của API trong cổng thông tin của bạn.

      Hình ảnh hiển thị Để hiển thị 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 một hình ảnh bên ngoài và nhấp vào Chọn. Xem trước hình thu nhỏ của API rồi nhấp vào Chọn. Bạn có thể thêm hình ảnh vào lúc khác, như mô tả trong phần Quản lý hình ảnh cho thẻ API. Khi bạn chỉ định một hình ảnh có URL bên ngoài, hình ảnh đó sẽ không được tải lên thành phần của bạn. Ngoài ra, việc tải hình ảnh trong cổng thông tin tích hợp sẽ phụ thuộc vào tình trạng của hình ảnh đó. Hình ảnh có thể bị chặn hoặc bị hạn chế theo chính sách bảo mật nội dung.
      Loại

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

      • Chọn một danh mục trong danh sách thả xuống.
      • Thêm một danh mục mới bằng cách nhập tên của danh mục đó rồi 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 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 xuất bản trên cổng thông tin của mình.

    Cách 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 được 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 nội dung đã lỗi thời, 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 một tài liệu OpenAPI đã lỗi thời, hãy nhấp vào Refresh Snapshot (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 phần 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 khảo API được hiển thị từ tài liệu và được thêm vào trang Tài liệu tham khảo API. Trạng thái của ả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 hiện tại

    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. Truy cập danh mục API.
    2. Nhấp vào thẻ API nếu bạn 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, hãy 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 huỷ xuất bản API trên cổng thông tin của bạn tương ứng.
    6. Nhấp vào Lưu.

    Quản lý chế độ hiển thị của một API trong cổng thông tin

    Quản lý chế độ hiển thị của một API trong cổng thông tin bằng cách cho phép truy cập vào:

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

    1. Truy cập danh mục API.
    2. Nhấp vào thẻ API nếu bạn 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 chế độ hiển thị API, hãy chọn một trong các tuỳ chọn sau:

    6. Chọn chế độ hiển thị. Nếu bạn đã đăng ký sử dụng 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 tuỳ chọn sau:

      • Công khai (hiển thị cho mọi người) để cho phép mọi 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 đã chọn để chọn những đối tượng cụ thể mà bạn muốn có thể xem trang. Xem phần 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 tuỳ 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 một API. Hãy xem phần Giới thiệu về URL gọi lại.

    Cách quản lý URL gọi lại cho một API:

    1. Truy cập danh mục API.
    2. Nhấp vào thẻ API, nếu chưa được 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, hãy 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 huỷ xuất bản API trên cổng thông tin của bạn tương ứng.
    6. Nhấp vào Lưu.

    Quản lý hình ảnh cho 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 thẻ API:

    1. Truy cập danh mục API.
    2. Nhấp vào thẻ API nếu bạn 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 thông tin chi tiết về API:

      • Nhấp vào Chọn hình ảnh để chỉ định hoặc tải hình ảnh lên nếu hiện không có hình ảnh nào được chọn.
      • Nhấp vào Thay đổi hình ảnh để chỉ định hoặc tải một hình ảnh khác lên.
      • Nhấp vào biểu tượng x trong hình ảnh để xoá hình ảnh đó.

      Khi chỉ định hình ảnh, hãy chỉ định một hình ảnh có URL bên ngoài được dùng cho mục trong danh mục hoặc đường dẫn tệp cho các tệp hình ảnh được lưu trữ trong cổng thông tin, ví dụ: /files/book-tree.jpg. Khi chỉ định URL của một hình ảnh bên ngoài, hình ảnh sẽ không được tải lên thành phần; Ngoài ra, việc tải hình ảnh trong phiên bản cổng thông tin sẽ tuỳ thuộc vào khả năng sử dụng của cổng thông tin. Cổng này có thể bị chặn hoặc bị hạn chế bởi chính sách bảo mật nội dung của Google.

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

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

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

    • Quản lý các danh mục được gắn thẻ API khi chỉnh sửa API, như mô tả bên dưới.
    • Quản lý các API được gắn thẻ vào 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 được 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 một danh mục trong danh sách thả xuống.
      • Thêm một danh mục mới bằng cách nhập tên của danh mục đó rồi nhấn phím 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 để gắn thẻ API cho nhiều danh mục hơn.
    7. Nhấp vào Lưu.

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

    Cách chỉnh sửa tiêu đề hiển thị và nội dung mô tả:

    1. Truy cập danh mục API.
    2. Nhấp vào thẻ API nếu bạn 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 Hiển thị tiêu đề và Hiển thị nội dung mô tả theo yêu cầu.
    6. Nhấp vào Lưu.

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

    Cách xoá một API khỏi cổng thông tin:

    1. Truy cập vào danh mục API.
    2. Chọn API nếu bạn chưa 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 có liên quan

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

    Khám phá trang Danh mục

    Cách xem trang Danh mục:

    1. Chọn Xuất bản > Cổng thông tin rồi chọn cổng thông tin 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 ở thanh điều hướng trên cùng.

    3. Nhấp vào tab 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 thông tin của bạn.

    Thẻ Danh mục cho biết tên danh mục, tên danh mục và tổng số API được chỉ định

    Như đã nê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:

    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.

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

    1. Truy cập vào trang Danh mục.
    2. Nhấp vào +.
    3. Nhập tên của danh mục mới.
    4. Bạn có thể chọn một hoặc nhiều API để gắn thẻ cho danh mục.
    5. Nhấp vào Tạo.

    Chỉnh sửa danh mục

    Cách chỉnh sửa danh mục:

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

    Xóa danh mục

    Khi bạn xoá một danh mục, tất cả thẻ API liên quan đến danh mục đó cũng sẽ bị xoá.

    Cách xoá danh mục:

    1. Truy cập vào trang Danh mục.
    2. Đặt con trỏ lên danh mục mà bạn muốn chỉnh sửa để hiển thị trình đơn thao tác.
    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 vấn đề liên quan đến 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ể với các API đã xuất bản của chúng tôi.

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

    Khi sử dụng Thử API này, 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ể là 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 tài liệu OpenAPI của mình. Ví dụ:

      schemes:
   - https
   - http

    • Đối với 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 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 Định cấu hình proxy API của bạn để hỗ trợ Dùng 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.

    Để sửa lỗi này, hãy sửa đổi chính sáchImplementMessage để sử dụng <Set> nhằm đặt tiêu đề CORS thay vì <Add>, như minh hoạ trong phần trích dẫn bên dưới. Để biết thêm thông tin, hãy xem bài viết liên quan trê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 sử dụng trường tiêu đề yêu cầu

    Khi sử dụng tính nă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, bạn có thể cần 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 AssignMessage, như mô tả trong phần Đí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ề một mã phản hồi chứa một số thuộc tính không tuân thủ RFC. Ví dụ: chính sách sẽ trả về một mã thông báo có giá trị BearerToken, thay vì giá trị Bearer tuân thủ RFC dự kiến. Phản hồi token_type không hợp lệ này có thể dẫn đến lỗi Access denied khi sử dụng tính nă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ặc AssignMessage để 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 phần hành vi không tuân thủ RFC.