คุณกําลังดูเอกสารประกอบของ Apigee Edge
ไปที่เอกสารประกอบของ Apigee X info
Apigee ขอแนะนําให้คุณใช้แนวทางปฏิบัติแนะนำที่อธิบายไว้ในส่วนต่อไปนี้เมื่อสร้างพอร์ทัล
ดึงดูดผู้ชม
เพิ่มเนื้อหาที่ดึงดูดผู้ชมด้วยภาพและกระตุ้นให้ผู้ชมอยากดูข้อมูลเพิ่มเติม อนุญาตให้ผู้ใช้ API สำรวจพอร์ทัลได้บางส่วนโดยไม่ต้องเข้าสู่ระบบ ให้บริการลงทะเบียนแบบบริการตนเองเพื่อให้ผู้ใช้เริ่มต้นใช้งานอย่างรวดเร็วเพื่อสร้างแอปโดยใช้ API ของคุณ
อนุญาตให้ผู้ใช้ลองใช้ API
สร้างเอกสารประกอบ API แบบอินเทอร์แอกทีฟโดยอัตโนมัติจากข้อมูลจำเพาะ OpenAPI เพื่อให้ผู้ใช้ทำสิ่งต่อไปนี้ได้
- ดูข้อมูลเกี่ยวกับ API
- ส่งคําขอแบบเรียลไทม์ไปยัง API
ดูการตอบกลับแบบเรียลไทม์ที่แสดงผลจาก API
โปรดดูข้อมูลเพิ่มเติมที่หัวข้อเผยแพร่ API
จัดการเส้นทางการเรียนรู้หลัก
แสดงตัวอย่างกรณีการใช้งานและบทแนะนำที่เกี่ยวข้องกับกลุ่มเป้าหมายและอิงตามระดับประสบการณ์ของกลุ่มเป้าหมาย สาธิตด้วยตัวอย่าง เช่น ลำดับคำสั่ง curl ง่ายๆ หรืออธิบายขั้นตอนที่ซับซ้อนมากขึ้น
ใช้การปรับแต่งเว็บไซต์ให้ติดอันดับบนเครื่องมือค้นหา (SEO)
ตรวจสอบว่าเนื้อหาค้นหาได้ ลงทุนใน SEO ที่จะช่วยปรับปรุงการจัดอันดับในผลการค้นหาและช่วยให้ผู้ใช้ค้นพบเนื้อหาของคุณ
ใช้แนวทางปฏิบัติแนะนำต่อไปนี้เมื่อจัดโครงสร้างเนื้อหา ดูข้อมูลเพิ่มเติมและหลักเกณฑ์เพิ่มเติมจาก Google ได้ที่คู่มือการปรับแต่งเว็บไซต์ให้ติดอันดับบนเครื่องมือค้นหาของ Google สำหรับมือใหม่
แนวทางปฏิบัติแนะนำ | คำอธิบาย | ประโยชน์ |
---|---|---|
สร้าง URL ที่ใช้งานง่าย | สร้าง URL ที่เข้าใจง่ายและอ่านออกได้ กำหนด URL ของหน้าเว็บที่ใช้งานง่ายเมื่อเพิ่มหน้าเว็บลงในพอร์ทัล ตามที่อธิบายไว้ในสร้างหน้าเว็บ |
|
ระบุชื่อพอร์ทัลที่สื่อความหมาย | กําหนดชื่อพอร์ทัลที่ไม่ซ้ำกันและสื่อความหมายสําหรับพอร์ทัล ตามที่อธิบายไว้ในจัดการพอร์ทัล ระบบจะใช้เนื้อหานี้เพื่อป้อนข้อมูลในแท็ก <title> สำหรับหน้าแรก (index ) ของพอร์ทัล |
|
ทำให้เว็บไซต์ไปยังส่วนต่างๆ ได้ง่าย | กําหนดโครงสร้างการนําทางที่สมเหตุสมผลตามที่อธิบายไว้ในตั้งค่าการนําทาง |
|
ใช้วลีคีย์เวิร์ดอย่างเหมาะสมตลอดทั้งเนื้อหา | ใส่คีย์เวิร์ดในเนื้อหาเมื่อมีความเกี่ยวข้องและเหมาะสมที่จะทําเช่นนั้น ความโดดเด่นของสตริงคีย์เวิร์ดในหน้าเว็บจะช่วยปรับปรุงการจัดอันดับหน้าเว็บในผลการค้นหาได้ ลองคาดเดาสตริงคีย์เวิร์ดที่ผู้ใช้อาจใช้เมื่อค้นหาเนื้อหาของคุณ โปรดระมัดระวังอย่าใส่คีย์เวิร์ดมากเกินไป ซึ่งก็คือการใช้คีย์เวิร์ดมากเกินไปโดยมีจุดประสงค์เพื่อปรับปรุงการจัดอันดับการค้นหาเพียงอย่างเดียว ซึ่งอาจส่งผลให้เว็บไซต์ถูกเครื่องมือค้นหาลงโทษ | ผู้ใช้ที่ค้นหาเนื้อหาจะมีแนวโน้มที่จะได้รับผลการค้นหาที่เกี่ยวข้องมากขึ้น |
สร้างชุมชนนักพัฒนาแอป
ใช้โซเชียลมีเดียเพื่อโปรโมตชุมชน API ผ่านช่องทางโซเชียลมาตรฐาน เช่น Facebook, Twitter และอื่นๆ เผยแพร่บล็อกและฟอรัมที่ช่วยส่งเสริมการสื่อสารและการโต้ตอบระหว่างนักพัฒนาซอฟต์แวร์ในชุมชน API