แนวทางปฏิบัติแนะนําในการสร้างพอร์ทัล

คุณกำลังดูเอกสารประกอบของ Apigee Edge
ไปที่ เอกสารประกอบของ Apigee X
info

Apigee ขอแนะนำให้คุณใช้แนวทางปฏิบัติแนะนำที่อธิบายไว้ในส่วนต่อไปนี้เมื่อสร้างพอร์ทัล

ดึงดูดผู้ชม

เพิ่มเนื้อหาที่ดึงดูดผู้ชมด้วยภาพและกระตุ้นให้ผู้ชมต้องการเรียนรู้เพิ่มเติม เปิดโอกาสให้ผู้ใช้ API ได้สำรวจพอร์ทัลบางส่วนโดยไม่ต้องเข้าสู่ระบบ จัดให้มีการลงทะเบียนแบบบริการตนเองเพื่อให้ผู้ใช้เริ่มต้นใช้งานได้อย่างรวดเร็วเพื่อสร้างแอปโดยใช้ API ของคุณ

ให้ผู้ใช้ได้ลองใช้ API ของคุณ

สร้างเอกสารประกอบ API แบบโต้ตอบจากข้อมูลจำเพาะของ OpenAPI โดยอัตโนมัติเพื่อให้ผู้ใช้ทำสิ่งต่อไปนี้ได้

  • เรียนรู้เกี่ยวกับ API
  • ส่งคำขอแบบสดไปยัง API
  • ดูการตอบกลับแบบสดที่ส่งคืนจาก API

    ดูข้อมูลเพิ่มเติมได้ที่ เผยแพร่ API

ระบุเส้นทางการเรียนรู้หลัก

ระบุตัวอย่างกรณีการใช้งานและบทแนะนำที่เกี่ยวข้องกับผู้ชมและอิงตามระดับประสบการณ์ของผู้ชม แสดงตัวอย่าง เช่น ลำดับคำสั่ง curl แบบง่าย หรืออธิบายขั้นตอนที่ซับซ้อนมากขึ้น

ใช้การเพิ่มประสิทธิภาพเครื่องมือค้นหา (SEO)

ตรวจสอบว่าเนื้อหาของคุณค้นหาได้ ลงทุนใน SEO ที่ช่วยปรับปรุงอันดับของคุณในผลการค้นหาและช่วยให้ผู้ใช้ค้นหาเนื้อหาของคุณได้

การเพิ่มประสิทธิภาพเครื่องมือค้นหา

ใช้แนวทางปฏิบัติแนะนำต่อไปนี้เมื่อจัดโครงสร้างเนื้อหา ดูข้อมูลเพิ่มเติมและหลักเกณฑ์เพิ่มเติมจาก Google ได้ที่คู่มือเริ่มต้นการเพิ่มประสิทธิภาพเครื่องมือค้นหาของ Google

แนวทางปฏิบัติแนะนำ คำอธิบาย สิทธิประโยชน์
สร้าง URL ที่ใช้งานง่าย สร้าง URL ที่เข้าใจง่ายและอ่านได้ Define a user-friendly page URL when adding pages to your portal, as described in Create a page.
  • สื่อถึงวัตถุประสงค์ของหน้าในรูปแบบที่อ่านได้
  • การทำงานของคีย์เวิร์ดแบบเต็มหรือบางส่วนใน URL ของหน้าจะช่วยปรับปรุงอันดับในการค้นหา
  • โดยปกติแล้ว URL จะปรากฏในผลการค้นหา
ระบุชื่อพอร์ทัลที่สื่อความหมาย กำหนดชื่อพอร์ทัลที่ไม่ซ้ำกันและสื่อความหมายสำหรับพอร์ทัลของคุณตามที่อธิบายไว้ใน จัดการพอร์ทัล ระบบจะใช้เนื้อหานี้เพื่อป้อนข้อมูลในแท็ก <title> สำหรับหน้าแรก (index) ของพอร์ทัล
  • การทำงานของคีย์เวิร์ดแบบเต็มหรือบางส่วนในชื่อจะช่วยปรับปรุงอันดับในการค้นหา
  • โดยปกติแล้ว เนื้อหาของชื่อหน้าจะแสดงเป็นบรรทัดแรกของผลการค้นหา
ทำให้เว็บไซต์ใช้งานง่าย กำหนดโครงสร้างการนำทางที่สมเหตุสมผลตามที่อธิบายไว้ในตั้งค่าการนำทาง
  • ช่วยให้ผู้ใช้ทราบตำแหน่งของตนเอง
  • ช่วยให้ผู้ใช้ค้นหาเนื้อหาที่ต้องการได้อย่างรวดเร็วและง่ายดาย
ใช้คีย์เวิร์ดและวลีคีย์เวิร์ดที่หลากหลายตลอดทั้งเนื้อหา ใส่คีย์เวิร์ดในเนื้อหาเมื่อเกี่ยวข้องและสมเหตุสมผล ความโดดเด่นของสตริงคีย์เวิร์ดในหน้าอาจช่วยปรับปรุงอันดับของหน้าในผลการค้นหา ลองคาดการณ์สตริงคีย์เวิร์ดที่ผู้ใช้อาจใช้เมื่อค้นหาเนื้อหาของคุณ ระมัดระวังไม่ให้ ใส่คีย์เวิร์ดมากเกินไป นั่นคือการใช้คีย์เวิร์ดมากเกินไปโดยมีวัตถุประสงค์เพียงเพื่อปรับปรุงอันดับในการค้นหา ซึ่งอาจส่งผลให้เครื่องมือค้นหาลงโทษเว็บไซต์ของคุณ ผู้ใช้ที่ค้นหาเนื้อหามีแนวโน้มที่จะได้รับผลการค้นหาที่เกี่ยวข้องมากขึ้น

สร้างชุมชนนักพัฒนาแอป

ใช้โซเชียลมีเดียเพื่อโปรโมตชุมชน API ผ่านช่องทางโซเชียลมาตรฐาน เช่น Facebook, Twitter และอื่นๆ เผยแพร่บล็อกและฟอรัมที่ส่งเสริมการสื่อสารและการโต้ตอบระหว่างนักพัฒนาแอปในชุมชน API