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

Apigee khuyên 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 hấp dẫn khán giả về mặt hình ảnh và khiến họ muốn tìm hiểu thêm. Cho phép người dùng API khám phá một phần cổng thông tin của bạn mà không cần đăng nhập. Cung cấp tính năng tự đăng ký để họ có thể nhanh chóng bắt đầu xây dựng ứng dụng bằng API của bạn.

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

Tự động tạo tài liệu API tương tác từ Thông số kỹ thuật OpenAPI để cho phép 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 được trả về từ API

  Để biết thêm thông tin, hãy xem phần Xuất bản API.

Giải quyết 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 phù hợp với đối tượng của bạn và dựa trên mức độ kinh nghiệm của họ. Minh hoạ bằng ví dụ, chẳng hạn như một 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 có thể tìm kiếm được. Đầu tư vào SEO để cải thiện thứ hạng trong 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 nội dung. Để biết thêm thông tin và các nguyên tắc khác của Google, hãy xem Cẩm nang Tối ưu hoá cho công cụ tìm kiếm của Google.

Phương pháp hay nhất	Mô tả	Lợi ích
Tạo URL thân thiện với người dùng	Tạo URL dễ hiểu và 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, như mô tả trong phần Tạo trang.	Truyền đạt mục đích của trang ở dạng mà con người có thể đọc được. Việc khớp từ khoá toàn bộ hoặc một phần trong URL của trang sẽ giúp 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 thông tin mô tả	Xác định tên cổng thông tin riêng biệt và mô tả cho cổng thông tin của bạn, như mô tả trong phần Quản lý cổng thông tin. Nội dung này được dùng để điền sẵn thẻ <title> cho trang chủ (index) của cổng thông tin.	Việc khớp từ khoá toàn bộ hoặc một phần trong tiêu đề sẽ giúp cải thiện thứ hạng tìm kiếm. Thông thường, nội dung của tiêu đề trang sẽ xuất hiện ở dòng đầu tiên của kết quả tìm kiếm.
Giúp người dùng dễ dàng di chuyển trên trang web	Xác định một cấu trúc điều hướng hợp lý, như mô tả trong phần Thiết lập điều hướng.	Giúp người dùng định hướng. Giúp người dùng nhanh chóng và dễ dàng tìm thấy nội dung họ muốn.
Sử dụng kết hợp hiệu quả các cụm từ khoá trong nội dung	Thêm từ khoá vào nội dung khi từ khoá đó có liên quan và phù hợp. Việc một chuỗi từ khoá xuất hiện nổi bật trên trang có thể giúp cải thiện thứ hạng của trang trong kết quả tìm kiếm. Hãy thử dự đoán những cụm 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 cẩn thận để không nhồi nhét từ khoá, tức là lạm dụng từ khoá chỉ với mục đích cải thiện thứ hạng tìm kiếm. Điều này có thể khiến trang web của bạn bị các 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 các kết quả phù hợp hơn.

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 tiêu chuẩn, chẳng hạn như Facebook, Twitter, v.v. Phát hành blog và diễn đàn để thúc đẩy hoạt động giao tiếp và tương tác giữa các nhà phát triển trong cộng đồng API của bạn.