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

Phát hành là quá trình cung cấp các API của bạn cho các 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ề tính năng phát hành API.

API phát hành bao gồm các tác vụ sau, đượ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à sự hỗ trợ của cộng đồng cho các API của bạn.

Nhiệm vụ 1: Tạo một 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 một 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 các nhà phát triển ứng dụng tiêu thụ. Tạo các sản phẩm API bằng cách sử dụng giao diện người dùng hoặc API 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 thể hiện một nhà phát triển, ứng dụng, API và các dịch vụ phụ trợ. Biểu tượng API và các tài nguyên được làm nổi bật. Một đường chấm trỏ từ nhà phát triển đến biểu tượng của một ứng dụng mà nhà phát triển đã xây dựng. 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 một biểu tượng API, trong đó có một khoá ứng dụng được đặt phía trên yêu cầu. Biểu tượng API và các 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 truyền thông. Sản phẩm Vị trí cung cấp tài nguyên cho /countries, /cities và /languages, còn sản phẩm Truyền thông có tài nguyên về /books, /movies 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, xe buýt dịch vụ doanh nghiệp, máy chủ ứng dụng và một phần phụ trợ chung.

Trong hình này, API bao gồm 2 sản phẩm, mỗi sản phẩm lại chứa 3 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, các giới hạn về việc 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 truy cập chỉ đọc vào 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 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ư 1000 yêu cầu mỗi ngày.
  • Phát hành một sản phẩm API thứ ba với mức giá cao hơn, cho phép đọc/ghi 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 mang đến cho bạn sự linh hoạt để tạo các sản phẩm API phù hợp với yêu cầu kinh doanh của các API của bạn.

Để biết thêm thông tin về cách tạo sản phẩm API, hãy xem nội dung 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 ra những ứng dụng sử dụng API của bạn. Một 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 ai có quyền truy cập vào các API của bạn. 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ẽ làm mất hiệu lực tất cả cá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 thể hiện một nhà phát triển, ứng dụng, API và các dịch vụ phụ trợ. Biểu tượng nhà phát triển được làm nổi bật. Một đường thẳng chấm 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 đã xây dựng. 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 một biểu tượng API, trong đó có một khoá ứng dụng được đặt 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 truyền thông. Sản phẩm Vị trí cung cấp tài nguyên cho /countries, /cities và /languages, còn sản phẩm Truyền thông có tài nguyên về /books, /movies 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, xe buýt dịch vụ doanh nghiệp, máy chủ ứng dụng và một phần phụ trợ chung.

Là nhà cung cấp API, bạn quyết định cách đăng ký cho nhà phát triển. Ví dụ: bạn có thể sử dụng quy trình đăng ký thủ công, trong đó yêu cầu một nhà phát triển tiềm năng phải 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, họ và tên 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. Xem bài viết Quản lý nhà phát triển ứng dụng để tìm hiểu thêm.

Apigee cũng cung cấp các công cụ mà bạn có thể dùng để tự động hoá quy trình đăng ký dành cho 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ó của bạn. Edge Management API (API Quản lý Edge) là một API REST mà bạn có thể dùng để thực hiện mọi khía cạnh của quy trình đăng ký dành cho nhà phát triển. Hãy xem bài viết 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 dịch vụ dành cho nhà phát triển Apigee để đăng ký cho nhà phát triển. Cổng thông tin này được tích hợp sẵn tính năng hỗ trợ đăng ký dành cho 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 phần Cổng thông tin cho nhà phát triển là gì? để biết thêm thông tin.

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

Để một ứng dụng có thể truy cập vào các 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 thể hiện một nhà phát triển, ứng dụng, API và các 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 thẳng từ nhà phát triển đến biểu tượng của một ứng dụng mà nhà phát triển xây dựng. 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 một biểu tượng API, trong đó có một khoá ứng dụng được đặt phía trên yêu cầu. Biểu tượng API và các 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 truyền thông. Sản phẩm Vị trí cung cấp tài nguyên cho /countries, /cities và /languages, còn sản phẩm Truyền thông có tài nguyên về /books, /movies 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, xe buýt dịch vụ doanh nghiệp, máy chủ ứng dụng và một phần phụ trợ chung.

Tại thời điểm đăng ký ứng dụng, nhà phát triển 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á khác nhau. Sau đó, nhà phát triển ứng dụng có thể chọn trong danh sách sản phẩm API có sẵn.

Để 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à yêu cầu sẽ được cấp nếu hợp lệ. Bất cứ lúc nào, với tư cách là nhà cung cấp dịch vụ, bạn có thể thu hồi khoá để ứng dụng không thể truy cập API của bạn nữa.

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

  • Sử dụng một 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. Đáp lại, bạn sẽ gửi cho nhà phát triển khoá API, có thể qua email.
  • Sử dụng Edge Management API để 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 thông tin Dịch vụ dành cho nhà phát triển Apigee được 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 phần Đăng ký ứng dụng và quản lý khoá API.

Nhiệm vụ 4: Ghi lại các API của bạn

Một yếu tố quan trọng cần cân nhắc đối với việc phát hành các sản phẩm API là cung cấp tài liệu và cơ chế phản hồi của nhà phát triển. Ngày càng có nhiều người dùng cổng thông tin dành cho nhà phát triển có tính năng xuất bản qua mạng xã hội để giao tiếp với cộng đồng nhà phát triển. Quy định này áp dụng cho việc truyền đạt nội dung tĩnh, chẳng hạn như tài liệu về API và điều khoản sử dụng, cũng như nội dung linh động do cộng đồng đóng góp 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 thể hiện một nhà phát triển, ứng dụng, API và các 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 về API, mẫu, hướng dẫn, tài liệu tham khảo API và các nội dung khác. Cổng thông tin này cũng chứa blog, diễn đàn và cổng hỗ trợ. Một đường chấm giữa biểu tượng nhà phát triển được làm nổi bật và biểu tượng của một ứng dụng mà nhà phát triển đã xây dựng. 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 một biểu tượng API, trong đó có một khoá ứng dụng được đặt 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 truyền thông. Sản phẩm Vị trí cung cấp tài nguyên cho /countries, /cities và /languages, còn sản phẩm Truyền thông có tài nguyên về /books, /movies 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, xe buýt dịch vụ doanh nghiệp, máy chủ ứng dụng và một 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 có tính phí, bạn có thể sử dụng Cổng Dịch vụ dành cho nhà phát triển API. Cổng thông tin có tính năng hỗ trợ tích hợp cho 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 khiến tài liệu API có khả năng tương tác đầy đủ. Tài liệu tương tác với SmartDocs đồng nghĩa với việc 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 mà API trả về

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 của một địa điểm 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í, rồi 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 có tính tương tác trên 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á các 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 các 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 có tính 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 phần Sử dụng SmartDocs cho API tài liệu.