Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào
tài liệu Apigee X. thông tin
Là một nhà cung cấp API, bạn cần có cách để cung cấp API, hướng dẫn nhà phát triển về API của bạn, đăng ký 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 mà bạn có thể dùng để xây dựng và ra mắt trang web 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 dành cho nhà phát triển, hãy xem bài viết Cổng thông tin dành 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 hiểu trước khi khắc phục các vấn đề 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 một quy cách OpenAPI (JSON hoặc YAML) hoặc WADL mô tả API của bạn 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 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 trực tiếp. 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 có chế độ hỗ trợ CORS (Chia sẻ tài nguyên trên nhiều nguồn gốc) để cho phép các yêu cầu này thành công. 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ự kiến. Proxy "smartdocs" được tạo khi bạn cài đặt SmartDocs.
Ví dụ:
URL của proxy smartdocs được hiển thị dưới dạng một thuộc tính có thể định cấu hình tại Configuration (Cấu hình) -> SmartDocs -> SmartDocs proxy URL (URL proxy SmartDocs). Bạn có thể cần sửa đổi URL này nếu API của bạn nằm trên một mạng riêng tư và các yêu cầu API trực tiếp bằng SmartDocs từ cổng thông tin của bạn không thành công.
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 cho nhà phát triển lưu trữ và truy xuất hầu hết thông tin mà cổng thông tin này hiển thị từ Edge, bao gồm cả Smartdocs, nhà phát triển, sản phẩm và ứng dụng của nhà phát triển. Bạn có thể định cấu hình thông tin về tổ chức Edge và thông tin đăng nhập devadmin bằng cách sử dụng lệnh trên trình đơn Configuration (Cấu hình) -> Devportal.
Để biết thêm thông tin, hãy xem phần Giao tiếp giữa cổng thông tin và Edge.