Các phương pháp hay nhất để xây dựng cổng thông tin

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

Bạn nên áp dụng các phương pháp hay nhất được mô tả trong các phần sau đây khi xây dựng cổng thông tin.

Thu hút khán giả

Thêm nội dung thu hút đối tượng về mặt hình ảnh và thôi thúc họ tìm hiểu thêm. Cho phép người dùng API khám phá một phần cổng của bạn mà không cần đăng nhập. Cung cấp quy trình tự đăng ký để họ có thể thiết lập và chạy ứng dụng một cách nhanh chóng bằng API của bạn.

Cho phép người dùng dùng thử các API của bạn

Tự động tạo tài liệu về API tương tác từ Thông số kỹ thuật OpenAPI để hỗ trợ người dùng:

• Tìm hiểu 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ề

  Để biết thêm thông tin, hãy xem phần Phát hành API.

Khám phá các lộ trình học tập chính

Cung cấp các ví dụ về trường hợp sử dụng và hướng dẫn có liên quan đến đối tượng của bạn và dựa trên cấp độ trải nghiệm của họ. Minh hoạ bằng ví dụ, chẳng hạn như trình tự lệnh curl đơn giản hoặc từng bước thực hiện một quy trình phức tạp hơn.

Triển khai hoạt động tối ưu hoá cho công cụ tìm kiếm (SEO)

Đảm bảo nội dung của bạn dễ tìm kiếm. Đầu tư vào SEO để cải thiện thứ hạng của bạn trên trang kết quả tìm kiếm và giúp người dùng tìm thấy nội dung của bạn.

Hãy áp dụng các phương pháp hay nhất sau đây khi xây dựng cấu trúc cho nội dung của bạn. Để biết thêm thông tin và các nguyên tắc bổ sung từ Google, hãy xem Hướng dẫn dành cho người mới làm quen với tối ưu hóa cho công cụ tìm kiếm của Google.

Phương pháp hay nhất	Nội dung mô tả	Lợi ích
Tạo URL thân thiện với người dùng	Tạo các URL dễ hiểu, dễ đọc. Xác định URL trang thân thiện với người dùng khi thêm trang vào cổng thông tin của bạn, như mô tả trong phần Tạo trang.	Truyền tải mục đích của trang ở dạng dễ đọc. Việc so khớp toàn bộ hoặc một phần từ khoá trong URL của trang sẽ cải thiện thứ hạng tìm kiếm. Thông thường, URL sẽ xuất hiện trong kết quả tìm kiếm.
Cung cấp tên cổng mang tính mô tả	Xác định tên cổng thông tin độc đáo và mang tính mô tả cho cổng của bạn, như được mô tả trong phần Quản lý cổng của bạn. Nội dung này được dùng để điền thẻ <title> cho trang chủ (index) của cổng thông tin.	Việc so khớp toàn bộ hoặc một phần từ khoá trong tiêu đề sẽ cải thiện thứ hạng tìm kiếm. Thông thường, nội dung của tiêu đề trang hiển thị ở dòng đầu tiên của kết quả tìm kiếm.
Làm cho trang web của bạn dễ điều hướng	Xác định cấu trúc điều hướng hợp lý, như mô tả trong bài viết Thiết lập tính năng điều hướng.	Luôn định hướng người dùng. Giúp người dùng tìm nội dung họ muốn một cách nhanh chóng và dễ dàng.
Sử dụng kết hợp các cụm từ khoá xuyên suốt nội dung	Đưa từ khoá vào nội dung khi thích hợp và phù hợp. Sự nổi bật của chuỗi từ khoá trên trang có thể cải thiện thứ hạng trang trong kết quả tìm kiếm. Hãy cố gắng dự đoán các chuỗi từ khoá mà người dùng có thể sử dụng khi tìm kiếm nội dung của bạn. Hãy thận trọng không để nội dung từ khoá (tức là sử dụng quá nhiều từ khoá cho mục đích duy nhất là cải thiện thứ hạng trong kết quả tìm kiếm). Điều này có thể khiến trang web của bạn bị công cụ tìm kiếm phạt.	Người dùng tìm kiếm nội dung sẽ có nhiều khả năng nhận được lượt truy cập có liên quan.

Xây dựng cộng đồng nhà phát triển

Sử dụng mạng xã hội để quảng bá cộng đồng API của bạn thông qua các kênh mạng xã hội chuẩn, chẳng hạn như Facebook, Twitter, v.v. Xuất bản các blog và diễn đàn để khuyến khích trao đổi và tương tác giữa các nhà phát triển trong cộng đồng API của bạn.