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 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. Kết xuất tài liệu tham khảo API từ thông tin tổng quan 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 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 API, cổng thông tin của bạn sẽ tự động cập nhật những nội dung 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. Xem:

• SmartTài liệu (OpenAPI)
• Trình khám phá GraphQL

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 các đườ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 các mục sau:

• Hình ảnh hiển thị cho mỗi thẻ API
• Danh mục được dùng cho API gắn thẻ nhằm giúp nhà phát triển khám phá các API liên quan trên trang API

Tài liệu thông minh (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 đượ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 của bạn và sử dụng bảng điều khiển Try this API (Dùng thử API này) để tạo yêu cầu API và xem kết quả. Hãy thử dùng API này với các điểm 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 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, hệ thống hỗ trợ các quy trình sau: mã uỷ quyền, mật khẩu và thông tin đăng nhập của ứng dụng.

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 này cho phép bạn xem các mã mẫu và lệnh gọi curl ở nhiều định dạng khác nhau, chẳng hạn như HTTP, Python, Node.js và các định dạng khác, như được hiển thị bên dưới.

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 thông tin 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á 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.

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 của bạn, nhà phát triển có thể chuyển tiêu đề uỷ quyền trong ngăn Tiêu đề của yêu cầu.

Để biết thêm thông tin về GraphQL, hãy xem graphql.org.

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 API. Bạn sử dụng cùng một tài liệu ở 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 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 bạn 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 một tài liệu?

Khi xuất bản API, bạn hãy chụp nhanh thông tin tổng quan nhanh của tài liệu OpenAPI hoặc GraphQL để kết xuất 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 lại toàn bộ tài liệu để 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ã 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 của mình. URL gọi lại thường chỉ định URL của ứ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ó cần 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 của bạn để hỗ trợ tính năng "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 của mình để 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 của bạn để 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) đượ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 "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.

• 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 Dùng thử API này trong tài liệu tham khảo API của 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 một proxy API.
Xác thực cơ bản	Thực hiện các bước sau: 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 một proxy API. Trong chính sách Add CORS (Thêm) của CORS, hãy đảm bảo rằng 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	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 một proxy API. Trong chính sách Add CORS (Thêm) của CORS, hãy đảm bảo rằng 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> Khắc phục 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 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 bài viết <GrantType>. Đảm bảo đặt token_type trong chính sách OAuth2 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 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ổ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 API đã được thêm vào cổng thông tin của bạn.

Như được đánh dấu trong hình trước, thẻ 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ỉnh sửa API trên cổng thông tin của bạn bằng cách thực hiện một hoặc nhiều tác vụ sau:
  • Quản lý ảnh chụp nhanh của tài liệu 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ý chế độ hiển thị của API trong cổng thông tin của bạn:
  • Quản lý URL gọi lại cho API
  • Quản lý hình ảnh cho thẻ API
  • Gắn thẻ API bằng danh mục
  • Chỉnh sửa tiêu đề và nội dung mô tả API
• Xoá API khỏi cổng thông tin
• Quản lý các danh mục dùng để khám phá các API liên quan
• Nhanh chóng xác định thông số kỹ thuật đã lỗi thời hoặc đã bị xoá khỏi cửa hàng thông số kỹ thuật
• 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

Cách thêm API vào 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ộp thoại Add an API product (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 Tiếp theo.
   Trang chi tiết về API sẽ xuất hiện.

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

   Trường	Nội dung mô tả
   Đã xuất bản	Chọ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 đề 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ị 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ả.
   Hiển thị mô tả	Cập nhật nội dung mô tả API xuất hiện 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 đề và nội dung mô tả hiển thị.
   Yêu cầu nhà phát triển chỉ định URL gọi lại	Bật nếu bạn muốn yêu cầu các 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 bài viết Quản lý URL gọi lại cho một API.
   Tài liệu API	Cách sử dụng tài liệu OpenAPI: Chọn OpenAPI document (Tài liệu OpenAPI). Nhấp vào Chọn tài liệu. 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ố 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. Nhấp vào Chọn. Cách sử dụng giản đồ GraphQL: Chọn Giản đồ GraphQL. Nhấp vào Chọn tài liệu. Chuyển đến và chọn giản đồ GraphQL. Nhấp vào Chọn. Ngoài ra, bạn có thể chọn Không có tài liệu nào và 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 những 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 (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 những người dùng đã đăng ký xem API. Đối tượng được chọn để chọn đố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 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ỏ 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 bài viết 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 một danh mục: Chọn một danh mục trong danh sách thả xuống. Thêm danh mục mới bằng cách nhập tên danh mục rồi nhấn Enter. Danh mục mới sẽ được thêm vào trang Danh mục và xuất hiện khi bạn 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 giấy tờ

Sau khi xuất bản API, bạn có thể chụp nhanh tài liệu OpenAPI hoặc GraphQL bất cứ 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 quản lý ảnh chụp nhanh của giấy 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. Kiểm tra trạng thái của bản tổng quan nhanh. Nếu phiên bản cũ hơn, thông báo sau sẽ hiển thị:
   
5. Nhấp vào .
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 được sử 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 và 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à 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:

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. 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 .
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ý chế độ hiển thị của 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ông khai (mọi người đều có thể nhìn thấy)
• Người dùng đã xác thực
• Đối tượng được chọn (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)

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

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 .
5. Trong 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ý 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ị với mọi người) để cho phép tất cả người dùng xem trang.
   • Người dùng được xác thực để chỉ cho phép những 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 phần Quản lý đối tượng cho cổng thông tin 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 những 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 .
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 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 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 .

5. Trong phần Thông tin chi tiết về 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 để xoá.

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 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, như 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 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 .
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 danh mục mới bằng cách nhập tên danh mục rồi nhấn Enter. Danh mục mới sẽ được thêm vào trang Danh mục và xuất hiện khi bạn 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 .
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 đượ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 .

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 trực tiếp. Thêm và quản lý các 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 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ổ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 mà bạn đã xác định cho cổng thông tin của mình.

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

• Xem các danh mục và API mà chúng được gắn thẻ
• Thêm danh mục
• Chỉnh sửa danh mục
• Xoá danh mục
• Quản lý các API đã xuất bản lên cổng thông tin của bạn. Xem phần Khám phá danh mục API

Thêm danh mục

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

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

Danh mục mới sẽ được thêm vào trang Danh mục và xuất hiện khi bạn 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. Chọn một hoặc nhiều API để gắn thẻ cho 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 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ả các thẻ API trong danh mục đó cũng sẽ bị xoá.

Để xóa danh mục:

1. Truy cập vào trang Danh mục.
2. Định vị con trỏ trê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 đề liên quan đến các API đã phát hành

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 đã phát hành.

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 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 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 khả thi 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 bạn. 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 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 Đị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 Thử API này, bạn có thể nhận được thông báo lỗi sau đây 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áchassignMessage để sử dụng <Set> nhằm thiết lập 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 có 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 cho phép trường tiêu đề của yêu cầu

Khi sử 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 phần Access-Control-Allow-Headers trong chính sách AttributionMessage của bạn, như mô tả trong Đí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 trả về một phản hồi 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ị Bearer tuân thủ tiêu chuẩn 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 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 đầ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.