API dokümantasyonunuzu mükemmelleştirmek için çok zaman harcamış olabilirsiniz, ancak arama motorlarında ilgili anahtar kelimeleri aradığınızda belgeleriniz sonuçlarda nadiren görünür. Sorun içeriğin kalitesizliği değil; belge siteniz için temel SEO optimizasyonunun eksikliğidir.
Apidog'un yayınladığı çevrimiçi belge siteleri, varsayılan olarak sitemap oluşturma, robots dosyası yönetimi, anlamsal URL'ler ve her sayfa için özelleştirilebilir meta veri etiketleri dahil olmak üzere bir dizi yerleşik SEO optimizasyonu ile birlikte gelir. Bunların hepsi, arama motorlarının içeriğinizi etkili bir şekilde taraması ve dizine eklemesi için kritik öneme sahiptir.
Bu varsayılan ayarlara ek olarak, özel ihtiyaçlarınızı karşılamak için SEO ayarlarını ince ayar yapabilirsiniz. Özellikler iki seviyeye ayrılmıştır: sayfa düzeyinde ayarlar ve site düzeyinde ayarlar. Sayfa düzeyindeki ayarlar, bireysel uç noktaları veya Markdown belgelerini optimize etmenize olanak tanırken, site düzeyindeki ayarlar tüm belge siteniz için birleşik yönetim sağlar.
Detaylara dalalım. Apidog sürümünüz eskiyse, önce en son sürüme güncellemenizi öneririz (aşağıdaki indirme düğmesine tıklayın).
Apidog İçinde Sayfa Düzeyinde SEO Ayarlarını Yapılandırma
Sayfa düzeyinde SEO ayarları, her bir uç noktanın veya Markdown dokümantasyon sayfasının arama motorlarında nasıl görüneceğini optimize etmenize olanak tanır. Yapılandırması basittir ve görünürlüğü ve tıklama oranlarını önemli ölçüde artırabilir.
Sayfa Düzeyinde SEO Ayarları Nasıl Yapılandırılır?
Adım 1: Optimize Etmek İstediğiniz Sayfayı Açın
Projenizde istediğiniz uç noktaya veya Markdown dokümantasyon sayfasına gidin.
Adım 2: SEO Ayarları Simgesine Tıklayın
Sayfanın sağ üst köşesindeki SEO Ayarları simgesini arayın. Ayarlar panelini açmak için tıklayın.
Adım 3: Özel Bir URL Slug'ı Ayarlayın
Varsayılan olarak, dokümantasyon sayfalarının URL'leri, okunabilir veya SEO dostu olmayan bir dizi sayı içeren sistem tarafından oluşturulur (örn. https://your-domain.com/5702007m0).
"Find pet by ID" uç noktası için "find-pet-by-id" gibi anlamlı bir URL slug'ı girebilirsiniz ve URL şöyle olur: https://your-domain.com/find-pet-by-id. Bu, URL'yi daha net ve hatırlanması daha kolay hale getirir.
Adım 4: Meta Başlığı ve Meta Açıklamasını Düzenleyin
Meta Başlığı: Bu, arama sonuçlarında gösterilen mavi başlıktır. Açık, anahtar kelime açısından zengin bir başlık sıralamaları iyileştirir ve tıklamaları teşvik eder.
Meta Açıklaması: Bu metin, arama sonuçlarında başlığınızın altında görünebilir. Arama motorları bazen otomatik olarak oluştururken, iyi yazılmış bir açıklama kullanıcıların sayfanın içeriğini hızla anlamasına yardımcı olur.
Adım 5: İlgili Anahtar Kelimeler Ekleyin (İsteğe Bağlı)
Arama motorları bugün meta anahtar kelimelere daha az güvense de, bunları eklemek yine de sayfanın konusunu işaret edebilir. Örneğin, "Find pet by ID" uç noktası için eklemek isteyebileceğiniz bazı anahtar kelimeler şunlardır: pet info, per store endpoint, pet data, REST API
Adım 6: Özel Meta Veri Ekleyin (Gelişmiş Seçenek)
Gelişmiş SEO kontrolü için JSON kullanarak özel meta etiketleri tanımlayabilirsiniz.
Örnek:
[ {"name": "robots", "content": "noindex"},
{"property": "og:image", "content": "https://your-domain.com/assets/image.png"}]Bunlar HTML'de standart <meta> etiketleri olarak işlenecek ve dizine eklemeyi veya sayfanın sosyal medyada paylaşılırken nasıl görüneceğini kontrol edebilir.
Apidog İçinde Site Düzeyinde SEO Ayarlarını Kurma
Tek sayfa SEO ayarlarının ötesinde, Apidog tüm belge sitenizde meta verileri, dizine ekleme kurallarını ve URL yönlendirmelerini yönetmenize yardımcı olacak kapsamlı, site düzeyinde SEO yapılandırması sunar.
Bu ayarlara dokümantasyonunuzu yayınlarken şuradan erişebilirsiniz:
Belgeleri Paylaş → Belge Sitelerini Yayınla → SEO Ayarları
1. Genel Meta Verileri Yapılandırma
Tüm dokümantasyon sayfalarına uygulanan meta etiketleri tanımlamak için Genel Meta Veriler'i kullanın. Bu, her sayfada işi tekrarlamadan tutarlı markalaşma sağlar ve SEO'yu iyileştirir. Genel meta verileri şu şekilde ayarlayabilirsiniz:
[
{"property": "og:title", "content": "{{PAGE_TITLE}} - {{SITE_NAME}}"}
]Şu yerleşik değişkenleri kullanabilirsiniz:
{{PAGE_TITLE}}{{PAGE_URL}}{{SITE_NAME}}{{SITE_ICON}}{{DESCRIPTION}}{{KEYWORDS}}
⚠️ Öncelik Kuralları: Sayfa düzeyinde SEO ayarları, Genel meta verileri geçersiz kılar, bu da Sistem varsayılanlarını geçersiz kılar.
2. robots.txt Dosyasını Yönetme
robots.txt dosyası, arama motorlarına hangi sayfaları tarayacakları konusunda talimatlar verir. Apidog, tüm tarayıcıların tüm sayfalara erişmesine izin veren ve sitemap dosyasına işaret eden temel bir robots.txt dosyasını otomatik olarak oluşturur.
Belirli sayfaların dizine eklenmesini önlemek istiyorsanız, genel Meta Verilere veya sayfa düzeyinde SEO ayarlarına {"name": "robots", "content": "noindex"} eklemeniz yeterlidir.
3. sitemap.xml Dosyasını Etkinleştirme veya Devre Dışı Bırakma
sitemap.xml özelliği, büyük bir SEO artışı sağladığı için varsayılan olarak etkindir. Bu dosya ("site haritası" olarak da bilinir), sitenizin bir dizini gibidir ve tüm sayfa URL'lerini listeler. Arama motoru tarayıcıları, içeriğinizi sistematik ve verimli bir şekilde dizine eklemek için bunu kullanır. Etkinleştirildiğinde, https://{your-domain.com}/sitemap.xml adresinden erişilebilir.
Bu özelliği devre dışı bırakmanız gerekirse, sistem sitemap oluşturmayı durduracak ve sitemap referansını kaldırmak için robots.txt dosyasını otomatik olarak güncelleyecektir.
4. 404 Hatalarını Önlemek İçin Belge Yönlendirme Kuralları Ayarlama
Yayınlanmış bir belgenin URL'sini değiştirirseniz (örneğin, SEO optimizasyonu için), trafiği ve arama motoru sıralamalarını korumak için Belge Yönlendirme Kuralları'nı kullanın. Yönlendirme kuralları ayarlayarak, eski URL'yi ziyaret eden kullanıcılar otomatik olarak yeni URL'ye gönderilir.
Yönlendirmeler Nasıl Ayarlanır:
1. SEO Ayarları panelindeki Belge Yönlendirme Kuralları bölümüne gidin.
2. Eski URL'yi ve Yeni URL'yi belirten bir kural ekleyin.
Bu, hem kullanıcıların hem de arama motorlarının 404 hatası almadan otomatik olarak doğru sayfaya gönderilmesini sağlar.
Apidog'da URL Adlandırma Stratejileri
URL ayarları için, sistem özel bir URL ayarlayıp ayarlamamanıza bağlı olarak farklı stratejiler kullanır. Ayarlarsanız, sistem doğrudan sizin değerinizi kullanır; örneğin, api-overview olarak ayarlanırsa, nihai adres https://{your-domain.com}/api-overview olur.
Özel bir URL ayarlamazsanız, iki otomatik oluşturma kuralı vardır:
- Kural 1: Başlık + Kimlik. örn.
https://{your-domain.com}/SEO-Settings-5702007m0. Bu, anlamsal bilgiyi benzersizlikle birleştirir, hem arama motorlarının hem de kullanıcıların sayfayı anlamasına yardımcı olur. - Kural 2: Sadece Kimlik. örn.
https://{your-domain.com}/5702007m0. Bu daha basittir ancak daha az açıklayıcıdır.
SEO açısından bakıldığında, URL'lerinizde anahtar kelimeler kullanmak genellikle daha iyi bir seçenektir; arama motorları sayfaları sıralarken URL anahtar kelimelerini dikkate alır. Bununla birlikte, dokümantasyon sitenizin zaten güçlü bir alan adı yetkisi varsa, anahtar kelime açısından zengin veya "anlamsal" URL'ler kullanmak daha az önemli hale gelir.
Çoğu web sitesi için, URL'ye anahtar kelimeler dahil etmek en iyi uygulamadır. Ancak, daha temiz URL'leri tercih ediyorsanız veya dokümantasyon yapınız karmaşıksa, basitleştirilmiş veya sistem tarafından oluşturulan URL'ler kullanmak da geçerli bir seçenektir.
API Dokümantasyonu SEO Yapılandırması İçin Pratik İpuçları
API dokümantasyonunuzu arama sonuçlarında daha görünür hale getirmek için şu adım adım SEO en iyi uygulamalarını izleyin:
1. Genel SEO Ayarlarıyla Başlayın
Varsayılan meta başlık, açıklama ve anahtar kelimeler gibi genel meta verileri ayarlayarak başlayın. Bu, tüm dokümantasyon sitenizde tutarlı bir SEO temeli oluşturur ve her sayfanın temel bilgileri kapsamasını sağlar.
2. Sayfa Düzeyinde SEO İçin Anahtar Sayfalara Öncelik Verin
Ardından, en önemli sayfalarınızı belirleyin; sık kullanılan uç noktalar, başlangıç kılavuzları veya hızlı başlangıç eğitimleri gibi. Bunlar en çok trafik çekmek istediğiniz sayfalardır.
Her biri için şunları özelleştirin:
- Meta Başlığı: Açık ve anahtar kelime açısından zengin yapın.
- Meta Açıklaması: Sayfa içeriğini kısa ve öz bir şekilde özetleyin.
- Anahtar Kelimeler: Kullanıcıların arayabileceği ilgili terimleri ekleyin.
3. Doğru URL Yapısını Seçin
URL kurallarını ayarlarken:
- Ekibiniz SEO'ya değer veriyorsa ve keşfedilebilirliği iyileştirmek istiyorsa başlık içeren URL'leri kullanın (örn.
/get-user-data). - Basitliği tercih ediyorsanız veya karmaşık bir dokümantasyon yapınız varsa sadece kimlik içeren URL'leri kullanın (örn.
/123456abc).
4. SEO'nun Uzun Vadeli Bir Oyun Olduğunu Anlayın
Mükemmel sayfa içi ayarlarla bile SEO zaman alır. Arama sıralamaları şunlara bağlıdır:
- Sitenizin alan adı yetkisi
- Diğer güvenilir kaynaklardan gelen geri bağlantılar
- Kullanıcı etkileşimi ve davranışı
- Arama motorları tarafından tarama sıklığı
Anında sonuç beklemeyin; sabırlı olun.
5. Verilere Dayalı Sürekli İyileştirme
SEO performansını düzenli olarak izleyin:
- Hangi sayfaların trafik aldığını ve hangilerinin almadığını görün.
- Kullanıcılardan geri bildirim toplayın.
- Zayıf sayfaları daha net içerik ve daha iyi meta verilerle güncelleyin.
Sonuç
Apidog, API dokümantasyonunuzun arama motorlarında daha iyi sıralanmasına yardımcı olacak kapsamlı bir SEO araç seti sunar. Bireysel sayfaları ince ayar yapabilir veya tüm sitenizdeki SEO ayarlarını tek bir yerden yönetebilirsiniz.
Temel özellikler şunları içerir:
- Daha temiz, anahtar kelime açısından zengin bağlantılar için özel URL'ler
- Daha iyi arama görünürlüğü için meta başlıklar ve açıklamalar
- Arama motorlarının sitenizi taramasına yardımcı olmak için sitemap oluşturma
- SEO değerini kaybetmeden içerik güncellemelerini yönetmek için yönlendirme kuralları
İster küçük sayfa düzeyinde düzenlemeler yapıyor olun ister genel ayarları yapılandırıyor olun, Apidog belgelerinizi arama için optimize etmek için ihtiyacınız olan her şeye sahiptir.
Daha fazla detay için, Apidog'un yardım belgelerindeki SEO Ayarları bölümüne göz atın.
Arama motoru optimizasyonu hakkında daha fazla bilgi edinmek isterseniz, şuraya bakın: