Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về
Apigee X. thông tin
Là một nhà cung cấp API, bạn cần có một cách để hiển thị API của mình, hướng dẫn nhà phát triển về API, đăng ký cho nhà phát triển và cho phép nhà phát triển đăng ký ứng dụng. Apigee Edge cung cấp cho bạn một cổng Dịch vụ dành cho nhà phát triển. Bạn có thể sử dụng cổng này để xây dựng và ra mắt trang web được tuỳ chỉnh của riêng mình nhằm cung cấp các dịch vụ này cho cộng đồng phát triển của bạn. Để tìm hiểu thêm về cổng thông tin cho nhà phát triển, hãy xem phần Cổng thông tin cho nhà phát triển là gì?
Các phần sau đây mô tả những khái niệm chính mà bạn cần nắm rõ trước khi khắc phục sự cố xảy ra với cổng thông tin dành cho nhà phát triển.
Cách hoạt động của SmartDocs
Bạn có thể nhập thông số kỹ thuật OpenAPI (JSON hoặc YAML) hoặc WADL mô tả API của mình vào SmartDocs và dùng để xuất bản tài liệu tham khảo API lên cổng thông tin của bạn. Tài liệu tham khảo API sẽ tự động xuất hiện trong thẻ API trên cổng thông tin của bạn. Nhà phát triển có thể khám phá tài liệu API thông qua cổng thông tin và có thể đưa ra các yêu cầu API theo thời gian thực. Vì các yêu cầu API bắt nguồn từ một trình duyệt, nên bạn cần hỗ trợ CORS (Chia sẻ tài nguyên trên nhiều nguồn gốc) để có thể thực hiện thành công các yêu cầu này. Tính năng hỗ trợ CORS được cung cấp bởi proxy "smartdocs" trên Edge (trong tổ chức "VALIDATE") đóng vai trò là proxy cho tất cả các yêu cầu SmartDocs đến điểm cuối dự định. Proxy "smartdocs" sẽ được tạo khi bạn cài đặt SmartDocs.
Ví dụ:
URL của proxy Smartdocs hiển thị dưới dạng thuộc tính có thể định cấu hình tại mục Cấu hình -> SmartDocs -> URL proxy SmartDocs. Bạn có thể cần sửa đổi URL này nếu API của bạn thuộc một mạng riêng và không thực hiện được các yêu cầu API đang hoạt động bằng SmartDocs từ cổng của bạn.
Cách Cổng thông tin dành cho nhà phát triển giao tiếp với Edge
Cổng thông tin dành cho nhà phát triển lưu trữ và truy xuất hầu hết thông tin hiển thị từ Edge, bao gồm cả Smartdocs, nhà phát triển, sản phẩm và ứng dụng dành cho nhà phát triển. Bạn có thể định cấu hình thông tin tổ chức ở Edge và thông tin đăng nhập quản trị viên nhà phát triển bằng cách sử dụng lệnh trong trình đơn Cấu hình -> Cổng thông tin phát triển.
Để biết thêm thông tin, hãy xem bài viết Giao tiếp giữa cổng thông tin và Edge.