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

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X. thông tin

Xuất bản là quy trình cung cấp API của bạn cho nhà phát triển ứng dụng để sử dụng.

Video: Video sau đây cung cấp thông tin giới thiệu tổng quan về việc phát hành API.

Việc phát hành API bao gồm các nhiệm vụ sau đây, được mô tả trong chủ đề này:

  1. Tạo các sản phẩm API trên Edge để gói các API của bạn.
  2. Đăng ký nhà phát triển ứng dụng trên Edge.
  3. Đăng ký ứng dụng dành cho nhà phát triển trên Edge.
  4. Cung cấp tài liệu và dịch vụ hỗ trợ cộng đồng cho API của bạn.

Nhiệm vụ 1: Tạo sản phẩm API trên Edge

Nhiệm vụ đầu tiên trong quá trình phát hành là tạo sản phẩm API. Sản phẩm API là một tập hợp các tài nguyên API được cung cấp dưới dạng gói cho nhà phát triển ứng dụng sử dụng. Tạo sản phẩm API bằng cách sử dụng API hoặc giao diện người dùng quản lý Edge. (Xem bài viết Sản phẩm API là gì? để tìm hiểu thêm về các sản phẩm API.)

Sơ đồ trình tự từ trái sang phải cho thấy nhà phát triển, ứng dụng, API và dịch vụ phụ trợ. Biểu tượng API và tài nguyên được làm nổi bật. Một đường chấm nối từ nhà phát triển đến biểu tượng của một ứng dụng mà nhà phát triển đã tạo. Các mũi tên từ và quay lại ứng dụng cho thấy luồng yêu cầu và phản hồi đến biểu tượng API, với khoá ứng dụng nằm phía trên yêu cầu. Biểu tượng API và tài nguyên được làm nổi bật. Bên dưới biểu tượng API là hai nhóm đường dẫn tài nguyên được nhóm thành hai sản phẩm API: Sản phẩm vị trí và Sản phẩm nội dung nghe nhìn. Sản phẩm Vị trí có tài nguyên cho /countries, /cities và /languages, còn sản phẩm Nội dung nghe nhìn có tài nguyên cho /books, /magazines và /movies. Ở bên phải API là các tài nguyên phụ trợ mà API đang gọi, bao gồm cơ sở dữ liệu, bus dịch vụ doanh nghiệp, máy chủ ứng dụng và phần phụ trợ chung.

Trong hình này, API bao gồm hai sản phẩm, mỗi sản phẩm chứa ba tài nguyên API.

Là nhà cung cấp API, bạn chịu trách nhiệm xây dựng các API và sản phẩm API để xử lý việc kiểm soát quyền truy cập, hạn chế sử dụng và mọi yêu cầu kinh doanh khác. Ví dụ: bạn có thể:

  • Phát hành một sản phẩm API miễn phí cho phép quyền chỉ đọc đối với các tài nguyên API của sản phẩm đó.
  • Phát hành sản phẩm API thứ hai với mức giá thấp, cho phép quyền đọc/ghi vào cùng các tài nguyên API như phiên bản miễn phí nhưng có giới hạn truy cập thấp, chẳng hạn như 1.000 yêu cầu mỗi ngày.
  • Phát hành sản phẩm API thứ ba với giá cao hơn, cho phép quyền đọc/ghi vào cùng một tài nguyên API nhưng có giới hạn truy cập cao.

Điều quan trọng cần nhớ là Edge cho phép bạn linh hoạt tạo các sản phẩm API phù hợp với các yêu cầu kinh doanh của API.

Để biết thêm thông tin về cách tạo sản phẩm API, hãy xem bài viết Tạo sản phẩm API.

Nhiệm vụ 2: Đăng ký nhà phát triển ứng dụng trên Edge

Nhà phát triển tạo các ứng dụng sử dụng API của bạn. Nhà phát triển ứng dụng đăng ký trên Apigee Edge trước khi có thể đăng ký ứng dụng. Khi đăng ký ứng dụng, họ sẽ nhận được một khoá API để cấp cho ứng dụng quyền truy cập vào API.

Thông qua quy trình đăng ký ứng dụng, bạn kiểm soát những người có quyền truy cập vào API của mình. Bất cứ lúc nào, bạn cũng có thể xoá một nhà phát triển ứng dụng. Thao tác này sẽ vô hiệu hoá tất cả khoá API liên kết với nhà phát triển đó, từ đó từ chối quyền truy cập của nhà phát triển đó vào API của bạn.

Sơ đồ trình tự từ trái sang phải cho thấy nhà phát triển, ứng dụng, API và dịch vụ phụ trợ. Biểu tượng nhà phát triển được làm nổi bật. Một đường chấm nối từ nhà phát triển được làm nổi bật đến biểu tượng của một ứng dụng mà nhà phát triển đó đã tạo. Các mũi tên từ và quay lại ứng dụng cho thấy luồng yêu cầu và phản hồi đến biểu tượng API, với khoá ứng dụng nằm phía trên yêu cầu. Bên dưới biểu tượng API là hai nhóm đường dẫn tài nguyên được nhóm thành hai sản phẩm API: Sản phẩm vị trí và Sản phẩm nội dung nghe nhìn. Sản phẩm Vị trí có tài nguyên cho /countries, /cities và /languages, còn sản phẩm Nội dung nghe nhìn có tài nguyên cho /books, /magazines và /movies. Ở bên phải API là các tài nguyên phụ trợ mà API đang gọi, bao gồm cơ sở dữ liệu, bus dịch vụ doanh nghiệp, máy chủ ứng dụng và phần phụ trợ chung.

Là nhà cung cấp API, bạn sẽ quyết định cách thức đăng ký nhà phát triển. Ví dụ: bạn có thể sử dụng quy trình đăng ký thủ công yêu cầu nhà phát triển tiềm năng liên hệ với tổ chức của bạn để đăng ký. Nhà phát triển tiềm năng phải cung cấp tất cả thông tin cần thiết, chẳng hạn như địa chỉ email, tên và họ, cũng như tên công ty. Nếu phê duyệt yêu cầu của nhà phát triển, bạn có thể sử dụng giao diện người dùng quản lý Edge để đăng ký nhà phát triển theo cách thủ công. Hãy xem bài viết Quản lý nhà phát triển ứng dụng để biết thêm thông tin.

Apigee cũng cung cấp các công cụ mà bạn có thể sử dụng để tự động hoá quy trình đăng ký nhà phát triển. Ví dụ:

  • Sử dụng API quản lý Apigee Edge để tích hợp chức năng đăng ký vào trang web hiện có. API quản lý Edge là một API REST mà bạn có thể sử dụng để thực hiện mọi khía cạnh của quy trình đăng ký nhà phát triển. Hãy xem phần Sử dụng API quản lý Edge để phát hành API để biết thêm thông tin.
  • Sử dụng cổng thông tin Dịch vụ dành cho nhà phát triển Apigee để đăng ký nhà phát triển. Cổng thông tin này tích hợp sẵn tính năng hỗ trợ đăng ký nhà phát triển, nhưng cũng có nhiều tính năng khác để hỗ trợ API của bạn. Hãy xem bài viết Cổng thông tin dành cho nhà phát triển là gì? để biết thêm thông tin.

Nhiệm vụ 3: Đăng ký ứng dụng dành cho nhà phát triển trên Edge

Trước khi có thể truy cập vào API của bạn, ứng dụng phải được đăng ký trên Edge. Tuy nhiên, chỉ nhà phát triển đã đăng ký mới có thể đăng ký ứng dụng trên Edge.

Sơ đồ trình tự từ trái sang phải cho thấy nhà phát triển, ứng dụng, API và dịch vụ phụ trợ. Các mũi tên ứng dụng, yêu cầu/phản hồi và khoá API được làm nổi bật. Một đường chấm nối từ nhà phát triển đến biểu tượng của một ứng dụng mà nhà phát triển đã tạo. Các mũi tên từ và quay lại ứng dụng cho thấy luồng yêu cầu và phản hồi đến biểu tượng API, với khoá ứng dụng nằm phía trên yêu cầu. Biểu tượng API và tài nguyên được làm nổi bật. Bên dưới biểu tượng API là hai nhóm đường dẫn tài nguyên được nhóm thành hai sản phẩm API: Sản phẩm vị trí và Sản phẩm nội dung nghe nhìn. Sản phẩm Vị trí có tài nguyên cho /countries, /cities và /languages, còn sản phẩm Nội dung nghe nhìn có tài nguyên cho /books, /magazines và /movies. Ở bên phải API là các tài nguyên phụ trợ mà API đang gọi, bao gồm cơ sở dữ liệu, bus dịch vụ doanh nghiệp, máy chủ ứng dụng và phần phụ trợ chung.

Tại thời điểm đăng ký ứng dụng, nhà phát triển sẽ chọn một hoặc nhiều sản phẩm API. Ví dụ: bạn có thể phát hành nhiều sản phẩm API tương ứng với nhiều loại dịch vụ và gói giá. Sau đó, nhà phát triển ứng dụng có thể chọn trong danh sách các sản phẩm API hiện có.

Để phản hồi việc đăng ký ứng dụng trên Edge, Edge sẽ chỉ định một khoá API duy nhất cho ứng dụng. Ứng dụng phải truyền khoá API đó trong mọi yêu cầu đến tài nguyên API. Khoá được xác thực và nếu hợp lệ, yêu cầu sẽ được cấp. Bất cứ lúc nào, với tư cách là nhà cung cấp dịch vụ, bạn cũng có thể thu hồi khoá để ứng dụng không thể truy cập vào API của bạn nữa.

Là nhà cung cấp API, bạn quyết định cách bạn muốn đăng ký ứng dụng. Bạn có thể:

  • Sử dụng quy trình thủ công yêu cầu nhà phát triển liên hệ với tổ chức của bạn để đăng ký ứng dụng. Để phản hồi, bạn sẽ gửi cho nhà phát triển khoá API, có thể là qua email.
  • Sử dụng API quản lý Edge để tích hợp chức năng đăng ký ứng dụng và phân phối khoá vào trang web của bạn.
  • Đối với tài khoản Edge có tính phí, hãy sử dụng cổng Dịch vụ dành cho nhà phát triển Apigee. Cổng này tích hợp sẵn tính năng hỗ trợ đăng ký ứng dụng và phân phối khoá API.

Để biết thêm thông tin, hãy xem bài viết Đăng ký ứng dụng và quản lý khoá API.

Nhiệm vụ 4: Ghi lại API

Một yếu tố quan trọng cần cân nhắc khi phát hành sản phẩm API là cung cấp tài liệu và cơ chế phản hồi dành cho nhà phát triển. Các cổng thông tin dành cho nhà phát triển có tính năng xuất bản trên mạng xã hội ngày càng được sử dụng để giao tiếp với cộng đồng phát triển. Điều này bao gồm việc truyền đạt nội dung tĩnh, chẳng hạn như tài liệu API và điều khoản sử dụng, cũng như nội dung động do cộng đồng đóng góp, chẳng hạn như blog và diễn đàn, cũng như các tính năng hỗ trợ khách hàng.

Sơ đồ trình tự từ trái sang phải cho thấy nhà phát triển, ứng dụng, API và dịch vụ phụ trợ. Biểu tượng nhà phát triển được làm nổi bật. Bên dưới nhà phát triển là một hộp đại diện cho cổng thông tin dành cho nhà phát triển. Cổng thông tin này chứa tài liệu API, mẫu, hướng dẫn, tài liệu tham khảo API và các tài liệu khác. Trang web này cũng chứa các blog, diễn đàn và một cổng hỗ trợ. Một đường chấm nối từ nhà phát triển được làm nổi bật đến biểu tượng của một ứng dụng mà nhà phát triển đó đã tạo. Các mũi tên từ và quay lại ứng dụng cho thấy luồng yêu cầu và phản hồi đến biểu tượng API, với khoá ứng dụng nằm phía trên yêu cầu. Bên dưới biểu tượng API là hai nhóm đường dẫn tài nguyên được nhóm thành hai sản phẩm API: Sản phẩm vị trí và Sản phẩm nội dung nghe nhìn. Sản phẩm Vị trí có tài nguyên cho /countries, /cities và /languages, còn sản phẩm Nội dung nghe nhìn có tài nguyên cho /books, /magazines và /movies. Ở bên phải API là các tài nguyên phụ trợ mà API đang gọi, bao gồm cơ sở dữ liệu, bus dịch vụ doanh nghiệp, máy chủ ứng dụng và phần phụ trợ chung.

Bạn có thể tạo trang web của riêng mình để triển khai tài liệu hoặc nếu có tài khoản Edge trả phí, bạn có thể sử dụng cổng Dịch vụ dành cho nhà phát triển Apigee. Cổng thông tin này tích hợp sẵn tính năng hỗ trợ tài liệu, blog, diễn đàn và các loại nội dung khác cần thiết để hỗ trợ cộng đồng nhà phát triển của bạn.

SmartDocs cho phép bạn ghi lại API của mình trên cổng Dịch vụ dành cho nhà phát triển theo cách giúp tài liệu API trở nên tương tác hoàn toàn. Tài liệu tương tác với SmartDocs có nghĩa là người dùng cổng thông tin có thể:

  • Đọc về API
  • Gửi yêu cầu trực tiếp đến API
  • Xem phản hồi trực tiếp được trả về từ API

Ví dụ: hình sau đây cho thấy một API được ghi lại trên cổng thông tin bằng cách sử dụng SmartDocs. API này cung cấp thông tin thời tiết cho một vị trí cụ thể:

Chủ đề phương thức API SmartDocs cho phép bạn gọi API thời tiết bằng cách nhấp vào một nút trong chủ đề.

Nhà phát triển nhập một giá trị cho tham số truy vấn "w" để chỉ định vị trí, sau đó nhấp vào nút Send the request (Gửi yêu cầu) để xem yêu cầu và phản hồi trực tiếp. Bằng cách tạo tài liệu tương tác về API, bạn giúp người dùng cổng thông tin dễ dàng tìm hiểu, kiểm thử và đánh giá API của bạn.

API quản lý Edge là một API REST cho phép bạn truy cập vào Dịch vụ API bằng bất kỳ ứng dụng HTTP nào. Apigee sử dụng SmartDocs để tạo tài liệu tương tác cho API quản lý Edge. Xem tài liệu về API đó tại đây.

Để biết thêm thông tin, hãy xem bài viết Sử dụng SmartDocs để ghi lại API.