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à nhà cung cấp API, bạn cần có cách để hiển thị API, hướng dẫn nhà phát triển về API, đă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ể sử 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. Để 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ả các khái niệm chính mà bạn nên nắm được trước khi khắc phục sự cố với trang web 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 khám phá tài liệu API thông qua cổng thông tin và có thể đưa ra yêu cầu API trực tiếp. Vì các yêu cầu API bắt nguồn từ trình duyệt, nên bạn cần hỗ trợ CORS (Chia sẻ tài nguyên chéo nguồn gốc) để các yêu cầu đó thành công. Hỗ trợ CORS do proxy "smartdocs" trên Edge (trong tổ chức "VALIDATE") cung cấp, đó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 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 nằm trên một mạng riêng và các yêu cầu API trực tiếp sử dụ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 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 xác thực devadmin bằng cách sử dụng lệnh trình đơn Configuration (Cấu hình) -> Devportal (Cổng phát triển).
Để biết thêm thông tin, hãy xem phần Giao tiếp giữa cổng thông tin và Edge.