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
Apigee khuyến nghị bạ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 về mặt thị giác và khiến khán giả 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 dịch vụ đăng ký tự phục vụ để 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 do API trả về
Để 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 khán giả và dựa trên trình độ kinh nghiệm của họ. Minh hoạ bằng ví dụ, chẳng hạn như một chuỗi lệnh curl đơn giản hoặc thực hiện từng bước trong 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 của bạn 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 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 SEO 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 bài viết Tạo trang. |
|
| Cung cấp tên cổng thông tin mang tính mô tả | Xác định một tên cổng duy nhất và mang tính mô tả cho cổng của bạn, như mô tả trong phần Quản lý cổng. 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. |
|
| Giúp người dùng dễ dàng điều hướng trên trang web của bạn | 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 hoạt động điều hướng. |
|
| Sử dụng kết hợp nhiều cụm từ khoá trong nội dung | Hãy thêm từ khoá vào nội dung khi phù hợp và có ý nghĩa. Mức độ nổi bật của một chuỗi từ khoá trên trang có thể 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 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 nhồi nhét từ khoá, tức là sử dụng quá nhiều từ khoá chỉ nhằm 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 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. Xuất bản 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.