คุณอาจใช้เวลามากมายในการทำให้เอกสาร API ของคุณสมบูรณ์แบบ แต่เมื่อคุณค้นหาคำหลักที่เกี่ยวข้องในเครื่องมือค้นหา เอกสารของคุณกลับไม่ค่อยปรากฏในผลลัพธ์ ปัญหานี้ไม่ใช่เพราะเนื้อหาไม่ดี แต่เป็นเพราะขาดการเพิ่มประสิทธิภาพ SEO ที่จำเป็นสำหรับเว็บไซต์เอกสารของคุณ
เว็บไซต์เอกสารออนไลน์ที่เผยแพร่โดย Apidog มาพร้อมกับการเพิ่มประสิทธิภาพ SEO ในตัวหลากหลายแบบเป็นค่าเริ่มต้น รวมถึงการสร้าง sitemap, การจัดการไฟล์ robots, URL ที่มีความหมาย (semantic URLs) และแท็ก metadata ที่ปรับแต่งได้สำหรับแต่ละหน้า ทั้งหมดนี้มีความสำคัญอย่างยิ่งเพื่อให้เครื่องมือค้นหาสามารถรวบรวมและจัดทำดัชนีเนื้อหาของคุณได้อย่างมีประสิทธิภาพ
นอกเหนือจากค่าเริ่มต้นเหล่านี้ คุณสามารถปรับแต่งการตั้งค่า SEO ให้ตรงกับความต้องการเฉพาะของคุณได้ คุณสมบัติแบ่งออกเป็นสองระดับ: การตั้งค่าระดับหน้า (page-level settings) และ การตั้งค่าระดับเว็บไซต์ (site-level settings) การตั้งค่าระดับหน้าช่วยให้คุณเพิ่มประสิทธิภาพ endpoint หรือเอกสาร Markdown แต่ละรายการได้ ในขณะที่การตั้งค่าระดับเว็บไซต์ให้การจัดการแบบรวมศูนย์สำหรับเว็บไซต์เอกสารทั้งหมดของคุณ
มาเจาะลึกรายละเอียดกัน หาก Apidog เวอร์ชันของคุณล้าสมัย เราขอแนะนำให้อัปเดตเป็นเวอร์ชันล่าสุดก่อน (คลิกปุ่มดาวน์โหลดด้านล่าง)
การกำหนดค่าการตั้งค่า SEO ระดับหน้าภายใน Apidog
การตั้งค่า SEO ระดับหน้าช่วยให้คุณสามารถเพิ่มประสิทธิภาพการแสดงผลของแต่ละ endpoint หรือหน้าเอกสาร Markdown ในเครื่องมือค้นหา การกำหนดค่านั้นง่ายและสามารถปรับปรุงการมองเห็นและอัตราการคลิกผ่านได้อย่างมาก
วิธีการกำหนดค่าการตั้งค่า SEO ระดับหน้า
ขั้นตอนที่ 1: เปิดหน้าที่คุณต้องการเพิ่มประสิทธิภาพ
ไปยัง endpoint หรือหน้าเอกสาร Markdown ที่ต้องการในโปรเจกต์ของคุณ
ขั้นตอนที่ 2: คลิกไอคอนการตั้งค่า SEO
มองหาไอคอน SEO Settings ที่ด้านบนขวาของหน้า คลิกเพื่อเปิดแผงการตั้งค่า
ขั้นตอนที่ 3: ตั้งค่า URL Slug แบบกำหนดเอง
โดยค่าเริ่มต้น URL ของหน้าเอกสารจะถูกสร้างขึ้นโดยระบบด้วยชุดตัวเลข (เช่น https://your-domain.com/5702007m0) ซึ่งไม่สามารถอ่านได้และไม่เป็นมิตรต่อ SEO
คุณสามารถป้อน URL slug ที่มีความหมาย เช่น "find-pet-by-id" สำหรับ endpoint "Find pet by ID" และ URL จะกลายเป็น: https://your-domain.com/find-pet-by-id ซึ่งทำให้ URL ชัดเจนและจำง่ายขึ้น
ขั้นตอนที่ 4: แก้ไข Meta Title และ Meta Description
Meta Title: นี่คือหัวข้อสีน้ำเงินที่แสดงในผลการค้นหา ชื่อเรื่องที่ชัดเจนและมีคำหลักที่เกี่ยวข้องช่วยปรับปรุงอันดับและกระตุ้นให้เกิดการคลิก
Meta Description: ข้อความนี้อาจปรากฏใต้ชื่อเรื่องของคุณในผลการค้นหา แม้ว่าเครื่องมือค้นหาบางครั้งจะสร้างขึ้นโดยอัตโนมัติ แต่คำอธิบายที่เขียนได้ดีจะช่วยให้ผู้ใช้เข้าใจเนื้อหาของหน้าได้อย่างรวดเร็ว
ขั้นตอนที่ 5: เพิ่มคำหลักที่เกี่ยวข้อง (ไม่บังคับ)
แม้ว่าเครื่องมือค้นหาจะพึ่งพา meta keywords น้อยลงในปัจจุบัน แต่การเพิ่มคำหลักก็ยังสามารถส่งสัญญาณถึงหัวข้อของหน้าได้ ตัวอย่างเช่น สำหรับ endpoint "Find pet by ID" นี่คือคำหลักบางส่วนที่คุณอาจต้องการเพิ่ม: pet info, per store endpoint, pet data, REST API
ขั้นตอนที่ 6: แทรก Metadata แบบกำหนดเอง (ตัวเลือกขั้นสูง)
สำหรับการควบคุม SEO ขั้นสูง คุณสามารถกำหนด meta tags แบบกำหนดเองโดยใช้ JSON
ตัวอย่าง:
[ {"name": "robots", "content": "noindex"},
{"property": "og:image", "content": "https://your-domain.com/assets/image.png"}]สิ่งเหล่านี้จะถูกแสดงผลเป็นแท็ก <meta> มาตรฐานใน HTML และสามารถควบคุมการจัดทำดัชนีหรือวิธีการแสดงผลของหน้าเมื่อแชร์บนโซเชียลมีเดียได้
การตั้งค่า SEO ระดับเว็บไซต์ภายใน Apidog
นอกเหนือจากการตั้งค่า SEO แบบหน้าเดียว Apidog ยังมีการกำหนดค่า SEO ระดับเว็บไซต์ที่ครอบคลุม เพื่อช่วยให้คุณจัดการ metadata, กฎการจัดทำดัชนี และการเปลี่ยนเส้นทาง URL ทั่วทั้งเว็บไซต์เอกสารของคุณ
คุณสามารถเข้าถึงการตั้งค่าเหล่านี้ได้ในขณะที่เผยแพร่เอกสารของคุณภายใต้:
Share Docs → Publish Docs Sites → SEO Settings
1. กำหนดค่า Global Metadata
ใช้ Global Metadata เพื่อกำหนด meta tags ที่ใช้กับหน้าเอกสารทั้งหมด ซึ่งช่วยให้มั่นใจได้ถึงการสร้างแบรนด์ที่สอดคล้องกันและปรับปรุง SEO โดยไม่ต้องทำงานซ้ำในทุกหน้า คุณสามารถตั้งค่า global metadata ได้ดังนี้:
[
{"property": "og:title", "content": "{{PAGE_TITLE}} - {{SITE_NAME}}"}
]คุณสามารถใช้ ตัวแปรในตัว (built-in variables) เช่น:
{{PAGE_TITLE}}{{PAGE_URL}}{{SITE_NAME}}{{SITE_ICON}}{{DESCRIPTION}}{{KEYWORDS}}
⚠️ กฎลำดับความสำคัญ: การตั้งค่า SEO ระดับหน้า (Page-level SEO settings) จะมีความสำคัญกว่า Global metadata ซึ่งจะมีความสำคัญกว่า ค่าเริ่มต้นของระบบ (System defaults)
2. จัดการ robots.txt
ไฟล์ robots.txt ให้คำแนะนำแก่เครื่องมือค้นหาเกี่ยวกับหน้าที่จะรวบรวม Apidog จะสร้างไฟล์ robots.txt พื้นฐานโดยอัตโนมัติ ซึ่งอนุญาตให้ crawler ทั้งหมดเข้าถึงทุกหน้าและชี้ไปยังไฟล์ sitemap
หากคุณต้องการป้องกันไม่ให้บางหน้าถูกจัดทำดัชนี เพียงเพิ่ม {"name": "robots", "content": "noindex"} ใน Global Metadata หรือการตั้งค่า SEO ระดับหน้า
3. เปิดหรือปิดใช้งาน sitemap.xml
คุณสมบัติ sitemap.xml ถูกเปิดใช้งานโดยค่าเริ่มต้น เนื่องจากเป็นตัวช่วย SEO ที่สำคัญ ไฟล์นี้ (หรือที่เรียกว่า "แผนผังเว็บไซต์") เปรียบเสมือนสารบบของเว็บไซต์ของคุณ ซึ่งแสดงรายการ URL ของทุกหน้า Crawler ของเครื่องมือค้นหาใช้สิ่งนี้เพื่อจัดทำดัชนีเนื้อหาของคุณอย่างเป็นระบบและมีประสิทธิภาพ เมื่อเปิดใช้งานแล้ว จะสามารถเข้าถึงได้ที่ https://{your-domain.com}/sitemap.xml
หากคุณต้องการปิดใช้งานคุณสมบัตินี้ ระบบจะหยุดสร้าง sitemap และอัปเดต robots.txt โดยอัตโนมัติเพื่อลบการอ้างอิง sitemap ออก
4. ตั้งค่า Docs Redirect Rules เพื่อหลีกเลี่ยงข้อผิดพลาด 404
หากคุณเปลี่ยน URL ของเอกสารที่เผยแพร่ (เช่น เพื่อการเพิ่มประสิทธิภาพ SEO) ให้ใช้ Docs Redirect Rules เพื่อรักษาปริมาณการเข้าชมและอันดับในเครื่องมือค้นหา การตั้งค่ากฎการเปลี่ยนเส้นทางจะทำให้ผู้ใช้ที่เข้าชม URL เก่าถูกส่งไปยัง URL ใหม่โดยอัตโนมัติ
วิธีการตั้งค่า Redirects:
1. ไปที่ส่วน Docs Redirect Rules ในแผง SEO Settings
2. เพิ่มกฎที่ระบุ old URL และ new URL
สิ่งนี้ช่วยให้มั่นใจได้ว่าทั้งผู้ใช้และเครื่องมือค้นหาจะถูกส่งไปยังหน้าเว็บที่ถูกต้องโดยอัตโนมัติ โดยไม่พบข้อผิดพลาด 404
กลยุทธ์การตั้งชื่อ URL ใน Apidog
สำหรับการตั้งค่า URL ระบบจะใช้กลยุทธ์ที่แตกต่างกันขึ้นอยู่กับว่าคุณตั้งค่า URL แบบกำหนดเองหรือไม่ หากคุณตั้งค่า ระบบจะใช้ค่าของคุณโดยตรง เช่น ตั้งค่าเป็น api-overview ที่อยู่สุดท้ายจะเป็น https://{your-domain.com}/api-overview
หากคุณไม่ได้ตั้งค่า URL แบบกำหนดเอง มีกฎการสร้างอัตโนมัติสองข้อ:
- กฎข้อที่ 1: Title + ID เช่น
https://{your-domain.com}/SEO-Settings-5702007m0นี่คือการรวมข้อมูลที่มีความหมายเข้ากับความเป็นเอกลักษณ์ ซึ่งช่วยให้ทั้งเครื่องมือค้นหาและผู้ใช้เข้าใจหน้าเว็บ - กฎข้อที่ 2: ID เท่านั้น เช่น
https://{your-domain.com}/5702007m0นี่เป็นวิธีที่ง่ายกว่า แต่ให้คำอธิบายน้อยกว่า
จากมุมมองของ SEO การใช้คำหลักใน URL โดยทั่วไปถือเป็นทางเลือกที่ดีกว่า เนื่องจากเครื่องมือค้นหาจะพิจารณาคำหลักใน URL เมื่อจัดอันดับหน้าเว็บ อย่างไรก็ตาม หากเว็บไซต์เอกสารของคุณมี Domain Authority ที่แข็งแกร่งอยู่แล้ว การใช้ URL ที่มีคำหลักหรือ "semantic" URLs ก็จะมีความสำคัญน้อยลง
สำหรับเว็บไซต์ส่วนใหญ่ การรวมคำหลักใน URL ถือเป็นแนวทางปฏิบัติที่ดีที่สุด อย่างไรก็ตาม หากคุณต้องการ URL ที่เรียบง่ายกว่า หรือโครงสร้างเอกสารของคุณมีความซับซ้อน การใช้ URL แบบง่ายหรือที่สร้างโดยระบบก็เป็นตัวเลือกที่ถูกต้องเช่นกัน
เคล็ดลับที่เป็นประโยชน์สำหรับการกำหนดค่า SEO เอกสาร API
เพื่อให้เอกสาร API ของคุณมองเห็นได้ชัดเจนยิ่งขึ้นในผลการค้นหา ให้ปฏิบัติตามแนวทางปฏิบัติที่ดีที่สุดด้าน SEO เหล่านี้ทีละขั้นตอน:
1. เริ่มต้นด้วยการตั้งค่า SEO ระดับ Global
เริ่มต้นด้วยการตั้งค่า global metadata เช่น meta title, description และ keywords เริ่มต้น สิ่งนี้จะสร้างรากฐาน SEO ที่สอดคล้องกันทั่วทั้งเว็บไซต์เอกสารของคุณ ทำให้มั่นใจได้ว่าทุกหน้ามีข้อมูลพื้นฐานครบถ้วน
2. จัดลำดับความสำคัญของหน้าสำคัญสำหรับการตั้งค่า SEO ระดับหน้า
ถัดไป ระบุหน้าสำคัญที่สุดของคุณ เช่น endpoint ที่ใช้บ่อย, คู่มือเริ่มต้นใช้งาน, หรือบทช่วยสอนแบบเร่งด่วน นี่คือหน้าเว็บที่คุณต้องการดึงดูดปริมาณการเข้าชมให้ได้มากที่สุด
สำหรับแต่ละหน้า ให้ปรับแต่ง:
- Meta Title: ทำให้ชัดเจนและมีคำหลักที่เกี่ยวข้อง
- Meta Description: สรุปเนื้อหาของหน้าให้กระชับ
- Keywords: เพิ่มคำที่เกี่ยวข้องที่ผู้ใช้อาจใช้ค้นหา
3. เลือกโครงสร้าง URL ที่เหมาะสม
เมื่อตั้งค่ากฎ URL:
- ใช้ URL ที่มีชื่อเรื่องรวมอยู่ (เช่น
/get-user-data) หากทีมของคุณให้ความสำคัญกับ SEO และต้องการปรับปรุงการค้นพบ - ใช้ URL ที่มีเฉพาะ ID (เช่น
/123456abc) หากคุณต้องการความเรียบง่าย หรือมีโครงสร้างเอกสารที่ซับซ้อน
4. เข้าใจว่า SEO เป็นเกมระยะยาว
แม้จะมีการตั้งค่า on-page ที่สมบูรณ์แบบ SEO ก็ต้องใช้เวลา อันดับการค้นหาขึ้นอยู่กับ:
- Domain authority ของเว็บไซต์คุณ
- Backlinks จากแหล่งที่เชื่อถือได้อื่นๆ
- การมีส่วนร่วมและพฤติกรรมของผู้ใช้
- ความถี่ในการรวบรวมข้อมูล (Crawl frequency) โดยเครื่องมือค้นหา
อย่าคาดหวังผลลัพธ์ในทันที จงอดทน
5. ปรับปรุงอย่างต่อเนื่องตามข้อมูล
ตรวจสอบประสิทธิภาพ SEO เป็นประจำ:
- ดูว่าหน้าใดมีการเข้าชมและหน้าใดไม่มี
- รวบรวมความคิดเห็นจากผู้ใช้
- อัปเดตหน้าที่มีประสิทธิภาพต่ำด้วยเนื้อหาที่ชัดเจนขึ้นและ metadata ที่ดีขึ้น
สรุป
Apidog มีชุดเครื่องมือ SEO ที่ครอบคลุมเพื่อช่วยให้เอกสาร API ของคุณมีอันดับที่ดีขึ้นในเครื่องมือค้นหา คุณสามารถปรับแต่งแต่ละหน้า หรือจัดการการตั้งค่า SEO ทั่วทั้งเว็บไซต์ของคุณได้ในที่เดียว
คุณสมบัติหลักได้แก่:
- Custom URLs สำหรับลิงก์ที่ชัดเจนและมีคำหลักที่เกี่ยวข้อง
- Meta titles และ descriptions เพื่อการมองเห็นในการค้นหาที่ดีขึ้น
- การสร้าง Sitemap เพื่อช่วยให้เครื่องมือค้นหารวบรวมข้อมูลเว็บไซต์ของคุณ
- Redirect rules เพื่อจัดการการอัปเดตเนื้อหาโดยไม่สูญเสียคุณค่า SEO
ไม่ว่าคุณจะทำการแก้ไขเล็กๆ น้อยๆ ในระดับหน้า หรือกำหนดค่าการตั้งค่าระดับ global Apidog มีทุกสิ่งที่คุณต้องการเพื่อเพิ่มประสิทธิภาพเอกสารของคุณสำหรับการค้นหา
สำหรับรายละเอียดเพิ่มเติม โปรดดูส่วน SEO Settings ในเอกสารช่วยเหลือของ Apidog
หากคุณต้องการเรียนรู้เพิ่มเติมเกี่ยวกับการเพิ่มประสิทธิภาพเครื่องมือค้นหา โปรดดู: