Anda mungkin telah menghabiskan banyak waktu untuk menyempurnakan dokumentasi API Anda, tetapi ketika Anda mencari kata kunci terkait di mesin pencari, dokumen Anda jarang muncul di hasil. Masalahnya bukan karena konten yang buruk—tetapi kurangnya optimasi SEO penting untuk situs dokumen Anda.
Situs dokumen online yang diterbitkan Apidog dilengkapi dengan berbagai optimasi SEO bawaan secara default, termasuk pembuatan sitemap, manajemen file robots, URL semantik, dan tag metadata yang dapat disesuaikan untuk setiap halaman. Semua ini penting agar mesin pencari dapat merayapi (crawl) dan mengindeks konten Anda secara efektif.
Selain pengaturan default ini, Anda dapat menyempurnakan pengaturan SEO untuk memenuhi kebutuhan spesifik Anda. Fitur-fitur dibagi menjadi dua tingkatan: pengaturan tingkat halaman dan pengaturan tingkat situs. Pengaturan tingkat halaman memungkinkan Anda mengoptimalkan endpoint individual atau dokumen Markdown, sementara pengaturan tingkat situs menyediakan manajemen terpadu untuk seluruh situs dokumen Anda.
Mari kita selami detailnya. Jika versi Apidog Anda sudah usang, kami sarankan untuk memperbarui ke versi terbaru terlebih dahulu (klik tombol unduh di bawah).
Mengonfigurasi Pengaturan SEO Tingkat Halaman di dalam Apidog
Pengaturan SEO tingkat halaman memungkinkan Anda mengoptimalkan bagaimana setiap endpoint atau halaman dokumentasi Markdown muncul di mesin pencari. Konfigurasinya sederhana dan dapat secara signifikan meningkatkan visibilitas dan tingkat klik-tayang (click-through rates).
Cara Mengonfigurasi Pengaturan SEO Tingkat Halaman
Langkah 1: Buka Halaman yang Ingin Anda Optimalkan
Navigasikan ke endpoint atau halaman dokumentasi Markdown yang diinginkan dalam proyek Anda.
Langkah 2: Klik Ikon Pengaturan SEO
Cari ikon Pengaturan SEO di kanan atas halaman. Klik untuk membuka panel pengaturan.
Langkah 3: Atur Slug URL Kustom
Secara default, URL halaman dokumentasi dibuat oleh sistem dengan serangkaian angka (misalnya, https://your-domain.com/5702007m0), yang tidak mudah dibaca atau ramah SEO.
Anda dapat memasukkan slug URL yang bermakna "find-pet-by-id" untuk endpoint "Find pet by ID", dan URL-nya menjadi: https://your-domain.com/find-pet-by-id. Ini membuat URL lebih jelas dan mudah diingat.
Langkah 4: Edit Judul Meta dan Deskripsi Meta
Judul Meta: Ini adalah judul biru yang ditampilkan di hasil pencarian. Judul yang jelas dan kaya kata kunci meningkatkan peringkat dan mendorong klik.
Deskripsi Meta: Teks ini mungkin muncul di bawah judul Anda di hasil pencarian. Meskipun mesin pencari terkadang membuatnya secara otomatis, deskripsi yang ditulis dengan baik membantu pengguna dengan cepat memahami konten halaman.
Langkah 5: Tambahkan Kata Kunci Relevan (Opsional)
Meskipun mesin pencari saat ini kurang mengandalkan kata kunci meta, menambahkannya masih dapat menandakan topik halaman. Misalnya, untuk endpoint "Find pet by ID", berikut adalah beberapa kata kunci yang mungkin ingin Anda tambahkan: pet info, per store endpoint, pet data, REST API
Langkah 6: Sisipkan Metadata Kustom (Opsi Lanjutan)
Untuk kontrol SEO lanjutan, Anda dapat mendefinisikan tag meta kustom menggunakan JSON.
Contoh:
[ {"name": "robots", "content": "noindex"},
{"property": "og:image", "content": "https://your-domain.com/assets/image.png"}]Ini akan dirender sebagai tag <meta> standar dalam HTML dan dapat mengontrol pengindeksan atau bagaimana halaman muncul saat dibagikan di media sosial.
Menyiapkan Pengaturan SEO Tingkat Situs di dalam Apidog
Selain pengaturan SEO satu halaman, Apidog menawarkan konfigurasi SEO tingkat situs yang komprehensif untuk membantu Anda mengelola metadata, aturan pengindeksan, dan pengalihan URL di seluruh situs dokumen Anda.
Anda dapat mengakses pengaturan ini saat menerbitkan dokumentasi Anda di bawah:
Bagikan Dokumen → Terbitkan Situs Dokumen → Pengaturan SEO
1. Konfigurasi Metadata Global
Gunakan Metadata Global untuk mendefinisikan tag meta yang berlaku di semua halaman dokumentasi. Ini memastikan branding yang konsisten dan meningkatkan SEO tanpa menduplikasi pekerjaan di setiap halaman. Anda dapat mengatur metadata global seperti ini:
[
{"property": "og:title", "content": "{{PAGE_TITLE}} - {{SITE_NAME}}"}
]Anda dapat menggunakan variabel bawaan seperti:
{{PAGE_TITLE}}{{PAGE_URL}}{{SITE_NAME}}{{SITE_ICON}}{{DESCRIPTION}}{{KEYWORDS}}
⚠️ Aturan Prioritas: Pengaturan SEO tingkat halaman menimpa (override) Metadata Global, yang menimpa Pengaturan default sistem.
2. Kelola robots.txt
File robots.txt memberikan instruksi kepada mesin pencari tentang halaman mana yang boleh dirayapi (crawl). Apidog secara otomatis menghasilkan robots.txt dasar yang mengizinkan semua perayap mengakses semua halaman dan menunjuk ke file sitemap.
Jika Anda ingin mencegah halaman tertentu diindeks, cukup tambahkan {"name": "robots", "content": "noindex"} di Metadata global atau pengaturan SEO tingkat halaman.
3. Aktifkan atau Nonaktifkan sitemap.xml
Fitur sitemap.xml diaktifkan secara default karena memberikan dorongan SEO yang besar. File ini (juga dikenal sebagai "peta situs") seperti direktori situs Anda, mencantumkan semua URL halaman. Perayap mesin pencari menggunakannya untuk mengindeks konten Anda secara sistematis dan efisien. Setelah diaktifkan, file ini dapat diakses di https://{your-domain.com}/sitemap.xml.
Jika Anda perlu menonaktifkan fitur ini, sistem akan berhenti menghasilkan sitemap dan secara otomatis memperbarui robots.txt untuk menghapus referensi sitemap.
4. Atur Aturan Pengalihan Dokumen untuk Menghindari Kesalahan 404
Jika Anda mengubah URL dokumen yang diterbitkan (misalnya, untuk optimasi SEO), gunakan Aturan Pengalihan Dokumen untuk mempertahankan lalu lintas dan peringkat mesin pencari. Dengan mengatur aturan pengalihan, pengguna yang mengunjungi URL lama akan secara otomatis dikirim ke URL yang baru.
Cara Mengatur Pengalihan:
1. Buka bagian Aturan Pengalihan Dokumen di panel Pengaturan SEO.
2. Tambahkan aturan yang menentukan URL lama dan URL baru.
Ini memastikan pengguna dan mesin pencari secara otomatis dikirim ke halaman yang benar tanpa mengalami kesalahan 404.
Strategi Penamaan URL di Apidog
Untuk pengaturan URL, sistem menggunakan strategi yang berbeda tergantung apakah Anda menetapkan URL kustom. Jika ya, sistem menggunakan nilai Anda secara langsung—misalnya, diatur ke api-overview, alamat akhirnya adalah https://{your-domain.com}/api-overview.
Jika Anda tidak menetapkan URL kustom, ada dua aturan pembuatan otomatis:
- Aturan 1: Judul + ID. misalnya,
https://{your-domain.com}/SEO-Settings-5702007m0. Ini menggabungkan info semantik dengan keunikan, membantu mesin pencari dan pengguna memahami halaman. - Aturan 2: Hanya ID. misalnya,
https://{your-domain.com}/5702007m0. Ini lebih sederhana tetapi kurang deskriptif.
Dari perspektif SEO, menggunakan kata kunci dalam URL Anda umumnya merupakan pilihan yang lebih baik—mesin pencari memang mempertimbangkan kata kunci URL saat memberi peringkat halaman. Namun, jika situs dokumentasi Anda sudah memiliki otoritas domain yang kuat, menggunakan URL yang kaya kata kunci atau "semantik" menjadi kurang penting.
Untuk sebagian besar situs web, menyertakan kata kunci dalam URL adalah praktik terbaik. Namun, jika Anda lebih suka URL yang lebih bersih atau struktur dokumentasi Anda kompleks, menggunakan URL yang disederhanakan atau dibuat oleh sistem juga merupakan opsi yang valid.
Tips Praktis untuk Mengonfigurasi SEO Dokumentasi API
Untuk membuat dokumentasi API Anda lebih terlihat di hasil pencarian, ikuti praktik terbaik SEO langkah demi langkah berikut:
1. Mulai dengan Pengaturan SEO Global
Mulailah dengan mengatur metadata global—seperti judul meta default, deskripsi, dan kata kunci. Ini menciptakan dasar SEO yang konsisten di seluruh situs dokumentasi Anda, memastikan setiap halaman memiliki dasar-dasar yang tercakup.
2. Prioritaskan Halaman Utama untuk SEO Tingkat Halaman
Selanjutnya, identifikasi halaman terpenting Anda—seperti endpoint yang sering digunakan, panduan onboarding, atau tutorial mulai cepat. Ini adalah halaman yang ingin Anda arahkan lalu lintas terbanyak.
Untuk setiap halaman, sesuaikan:
- Judul Meta: Buat jelas dan kaya kata kunci.
- Deskripsi Meta: Rangkum konten halaman secara ringkas.
- Kata Kunci: Tambahkan istilah relevan yang mungkin dicari pengguna.
3. Pilih Struktur URL yang Tepat
Saat mengatur aturan URL:
- Gunakan URL yang menyertakan judul (misalnya,
/get-user-data) jika tim Anda menghargai SEO dan ingin meningkatkan kemampuan ditemukan (discoverability). - Gunakan URL hanya ID (misalnya,
/123456abc) jika Anda lebih suka kesederhanaan atau memiliki struktur dokumentasi yang kompleks.
4. Pahami bahwa SEO adalah Permainan Jangka Panjang
Bahkan dengan pengaturan on-page yang sempurna, SEO membutuhkan waktu. Peringkat pencarian bergantung pada:
- Otoritas domain situs Anda
- Backlink dari sumber terpercaya lainnya
- Keterlibatan dan perilaku pengguna
- Frekuensi perayapan oleh mesin pencari
Jangan berharap hasil instan—bersabarlah.
5. Terus Tingkatkan Berdasarkan Data
Pantau kinerja SEO secara teratur:
- Lihat halaman mana yang mendapatkan lalu lintas dan mana yang tidak.
- Kumpulkan umpan balik dari pengguna.
- Perbarui halaman yang lemah dengan konten yang lebih jelas dan metadata yang lebih baik.
Kesimpulan
Apidog menyediakan toolkit SEO komprehensif untuk membantu dokumentasi API Anda mendapatkan peringkat yang lebih baik di mesin pencari. Anda dapat menyempurnakan halaman individual atau mengelola pengaturan SEO di seluruh situs Anda—semuanya di satu tempat.
Fitur utama meliputi:
- URL Kustom untuk tautan yang lebih bersih dan kaya kata kunci
- Judul dan deskripsi meta untuk visibilitas pencarian yang lebih baik
- Pembuatan Sitemap untuk membantu mesin pencari merayapi situs Anda
- Aturan pengalihan untuk mengelola pembaruan konten tanpa kehilangan nilai SEO
Baik Anda melakukan pengeditan kecil di tingkat halaman atau mengonfigurasi pengaturan global, Apidog memiliki semua yang Anda butuhkan untuk mengoptimalkan dokumen Anda untuk pencarian.
Untuk detail lebih lanjut, lihat bagian Pengaturan SEO di dokumen bantuan Apidog.
Jika Anda ingin mempelajari lebih lanjut tentang optimasi mesin pencari, lihat: