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, như được 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 gồm hai bước:

  1. Chọn sản phẩm API mà bạn muốn phát hành lên 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ề các 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ì?)

Những thông tin nào được xuất bản lên cổng thông tin?

Khi bạn xuất bản API, cổng thông tin của bạn sẽ tự động cập nhật những thông tin sau:
  • Tài liệu tham khảo API. Giao diện được cung cấp tuỳ 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 sẽ đượ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ả API đã xuất bản lên cổng thông tin của bạn (được liệt kê theo thứ tự bảng chữ cái), kèm theo đườ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. Nếu muốn, bạn có thể tuỳ chỉnh các mục sau:

    • Hình ảnh cho từng thẻ API
    • Các danh mục được dùng để gắn thẻ API, giúp nhà phát triển khám phá các API liên quan trên trang API

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

    • SmartDocs (OpenAPI)

    Khi bạn xuất bản 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 của bạn.

    Nhà phát triển có thể xem tài liệu tham khảo API SmartDocs của bạn và sử dụng bảng điều khiển Dùng thử API này để tạo yêu cầu API và xem kết quả. Hãy dùng thử API này với các thiết bị đầu cuối không bảo mật hoặc điểm cuối được bảo mật bằng cách sử dụng phương thức cơ bản, khoá API hoặc phương thứ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 quy trình sau được hỗ trợ: mã uỷ quyền, mật khẩu và thông tin đăng nhập ứng dụng.

    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, gỡ bảng điều khiển API này, tải thông số kỹ thuật có liên quan xuống và 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 được 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à các định dạng khác, như hiển thị dưới đây.

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

    Trình khám phá GraphQL

    Khi bạn xuất bản 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 của bạn. Trình khám phá dựa trên GraphiQL, một phương thức 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 đồ, tạo và chạy truy vấn, xem kết quả truy vấn cũng như tải giản đồ xuống. Để truy cập an toàn vào API, nhà phát triển có thể chuyể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 xem graphql.org.

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

    Thông tin tổng quan 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 một API. Cùng một tài liệu được sử dụng ở mỗi giai đoạn trong vòng đời của API, từ khi phát triển, phát hành 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 này đối với API của mình 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 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 để hiển thị 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 tài liệu. Nếu sửa đổi tài liệu, bạn có thể chụp một ảnh chụp nhanh khác để thể hiện 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ã ủy 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 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ã uỷ 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 xem 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 của mình. 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 một API.

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

    Định cấu hình proxy API của bạn để hỗ trợ "Dùng 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 Dùng 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 nhiều nguồn gốc phía máy khách

      CORS là một cơ chế tiêu chuẩn cho phép các lệnh gọi JavaScript XMLHttpRequest (XHR) 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à 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 trên tất cả các trình duyệt.

    • 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 cấu hình proxy API để hỗ trợ Dùng thử bảng điều khiển 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 của 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. Để 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 PagingMessage, hãy đảm bảo tiêu đề Access-Control-Allow-Headers có 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 đượ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 PagingMessage, hãy đảm bảo tiêu đề Access-Control-Allow-Headers có 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 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:
      • Nhớ đặ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 phần <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 thông tin của bạn. 2. Nhấp vào Danh mục API trên trang chủ 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.

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

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

    Như được làm nổi bật trong hình trước, thẻ 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:

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

    3. Nhấp vào +.

      Hộp thoại Thêm 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 Next (Tiếp theo). Trang chi tiết về 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:

      Kỹ thuật Nội dung 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 xuất bản API. Bạn có thể thay đổi chế độ cài đặt này sau theo cách 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.
      Tiêu đề hiển thị Cập nhật tiêu đề của API xuất hiện 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ả.
      Hiển thị mô tả Cập nhật nội dung mô tả về API được hiển thị trong danh mục. Theo mặc định, hệ thống sẽ sử dụng nội dung mô tả sản phẩm API. 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 nội dung mô tả và tiêu đề hiển thị.
      Yêu cầu nhà phát triển chỉ định một URL gọi lạiBật tính năng này 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 vào lúc khác, 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 OpenAPI document (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 một thông số kỹ thuật từ 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 một tệp lên.
        • Nhấp vào thẻ 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. 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 nào rồi thêm tài liệu sau 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ý 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ý 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 (ai cũng thấy được) để cho phép mọi người dùng xem API.
      • Người dùng được xác thực để chỉ cho phép người dùng đã đăng ký xem API.
      • Đối tượng đã 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, theo cách mô tả trong phần 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 một 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ỏ của API rồi nhấp vào Select (Chọn). Bạn có thể thêm hình ảnh sau, như mô tả trong phần Quản lý hình ảnh cho thẻ API. Khi bạn chỉ định hình ảnh bằng một URL bên ngoài, hình ảnh đó sẽ không được tải lên tài sả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 khả năng cung cấp hình ảnh. Hình ảnh đó có thể bị chặn hoặc hạn chế theo chính sách bảo mật nội dung.
      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. 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 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.

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

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

    Sau khi phát hành API, bất cứ lúc nào bạn cũng có thể chụp một ảnh chụp nhanh mới về tài liệu OpenAPI hoặc GraphQL để 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 vào 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 của bản tổng quan nhanh. Nếu mã này đã cũ, 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 thao tác 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 Refresh snapshot (Làm mới ảnh chụp nhanh).
      • Để thay đổi tài liệu được 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 khảo API được kết xuất từ tài liệu và được thêm vào trang Tài liệu tham khảo API. Trạng thái tổng quan nhanh được cập nhật thành:

    Biểu tượng và thông báo cho biết bản tổng quan nhanh đang được sử dụng

    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 phát hành hoặc huỷ xuất bản một API trên cổng thông tin của bạn:

    1. Truy cập vào 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 Thông tin chi tiết về API, hãy chọn hoặc bỏ chọn Đã xuất bản (liệt kê trong danh mục) để xuất bản hoặc huỷ xuất bản API tương ứng trên cổng thông tin của bạn.
    6. Nhấp vào Lưu.

    Quản lý chế độ 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 một API trong cổng thông tin của bạn bằng cách cấp quyền truy cập vào:

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

    1. Truy cập vào 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 lựa 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 lựa chọn sau:

      • Công khai (ai cũng thấy được) để cho phép mọi người dùng xem trang.
      • Người dùng được xác thực để chỉ cho phép người dùng đã đăng ký xem trang.
      • Đối tượng được chọn để chọn những đối tượng cụ thể mà 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 một API. Hãy xem bài viết 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 vào 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 Thông tin chi tiết về API, hãy chọn hoặc bỏ chọn Đã xuất bản (liệt kê trong danh mục) để xuất bản hoặc huỷ xuất bản API tương ứng trên cổng thông tin của bạn.
    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 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 vào 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:

      • Nhấp vào Chọn hình ảnh để chỉ định hoặc tải hình ảnh lên nếu hiện chưa chọn hình ảnh nào.
      • 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 dấu x trong hình ảnh để xoá.

      Khi chỉ định hình ảnh, hãy chỉ định hình ảnh có URL bên ngoài dùng cho mục 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, chẳng hạn như /files/book-tree.jpg. Khi chỉ định URL của hình ảnh bên ngoài, hình ảnh đó sẽ không được tải lên tài sả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ẽ tuỳ thuộc vào khả năng cung cấp hình ảnh đó. Hình ảnh đó có thể bị chặn hoặc hạn chế theo chính sách bảo mật nội dung.

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

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

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

    • Quản lý các danh mục mà API được gắn thẻ khi chỉnh sửa API, theo mô tả dưới đây.
    • 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 vào các danh mục khi chỉnh sửa API:

    1. Truy cập vào 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 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 vào các danh mục khác.
    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 vào 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.

    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. Truy cập vào danh mục API.
    2. Chọn API, nếu chưa chọn.
    3. Định vị 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 có liên quan trên trang API của cổng thông tin hoạt động. Thêm và quản lý 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 thông tin của bạn.
    2. Nhấp vào Danh mục API trên trang chủ 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 thẻ Danh mục.

    Thẻ 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.

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

    Như được làm nổi bật 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 trang Danh mục.
    2. Nhấp vào +.
    3. Nhập tên cho danh mục mới.
    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

    Cách 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 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ả các thẻ API liên kết với danh mục đó cũng sẽ bị xoá.

    Để xóa danh mục:

    1. Truy cập trang Danh mục.
    2. Định vị con trỏ lên danh mục 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 đề 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 các lỗi cụ thể xảy ra với các API mà chúng tôi đã xuất bản.

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

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

    • Đối với lỗi nội dung hỗn hợp, lỗi có thể do vấn đề về swagger-ui đã biết gây ra. Một giải pháp có thể là đảm bảo bạn chỉ định HTTPS trước HTTP trong định nghĩa schemes trong tài liệu OpenAPI của bạn. 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 thực hiện các yêu cầu trên 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ỉ được phép có một giá trị

    Khi sử dụng 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ách assignedMessage để sử dụng <Set> nhằm đặt các tiêu đề CORS thay vì <Add>, như minh hoạ trong phần trích dẫn dưới đây. Để 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: Trường tiêu đề yêu cầu không được phép

    Khi sử dụng API Dùng thử này, nếu bạn 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 phần Access-Control-Allow-Headers trong chính sách CORSTransactionMessage của bạn, như mô tả trong phần Đính kèm chính sách Thêm CORS vào một 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 sẽ trả về phản hồi bằng mã thông báo có 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ị tuân thủ RFC dự kiến là Bearer. 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 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ặc AttributionMessage để chuyển đổi dữ liệu đầ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.