Portalınızı oluşturmak için en iyi uygulamalar

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

Apigee, portalınızı oluştururken aşağıdaki bölümlerde açıklanan en iyi uygulamaları uygulamanızı önerir.

Kitlenizin ilgisini çekin

Kitlenizin görsel olarak ilgisini çeken ve daha fazla bilgi edinmek istemesini sağlayan içerikler ekleyin. API tüketicilerinin, portalınızın bir bölümünü oturum açmadan keşfetmesine olanak tanıyın. API'lerinizi kullanarak uygulama geliştirmeye hızlıca başlayabilmeleri için self servis kayıt imkanı sunun.

Kullanıcıların API'lerinizi denemesine izin verme

Kullanıcıların aşağıdakileri yapabilmesi için OpenAPI spesifikasyonlarınızdan otomatik olarak etkileşimli API belgeleri oluşturun:

  • API hakkında bilgi
  • API'ye canlı istek gönderme

  • API'den döndürülen canlı yanıtı görüntüleme

    Daha fazla bilgi için API'lerinizi yayınlama başlıklı makaleyi inceleyin.

Temel öğrenme rotalarını ele alma

Kitlenizle alakalı ve deneyim düzeylerine uygun kullanım alanı örnekleri ve eğitimler sunun. Basit bir curl komut dizisi gibi bir örnekle gösterin veya daha ayrıntılı bir prosedürü adım adım açıklayın.

Arama motoru optimizasyonu (SEO) uygulayın

İçeriğinizin aranabilir olduğundan emin olun. Arama sonuçlarındaki sıralamanızı iyileştiren ve kullanıcıların içeriğinizi bulmasını sağlayan SEO'ya yatırım yapın.

Arama motoru optimizasyonu

İçeriğinizi yapılandırırken aşağıdaki en iyi uygulamalardan yararlanın. Daha fazla bilgi ve Google'dan ek yönergeler için Google Arama Motoru Optimizasyonu Başlangıç Kılavuzu'na bakın.

En İyi Uygulama Açıklama Avantajları
Kullanıcı dostu URL'ler oluşturma Anlaşılması kolay, okunabilir URL'ler oluşturun. Sayfaları portalınıza eklerken Sayfa oluşturma bölümünde açıklandığı gibi kullanıcı dostu bir sayfa URL'si tanımlayın.
  • Sayfanın amacını okunabilir bir biçimde aktarır.
  • Sayfa URL'sinde tam veya kısmi anahtar kelime eşleştirme, arama sıralamasını iyileştirir.
  • URL'ler genellikle arama sonuçlarında görünür.
Açıklayıcı bir portal adı girin Portallarınızı yönetme bölümünde açıklandığı gibi, portalınız için benzersiz ve açıklayıcı bir portal adı tanımlayın. Bu içerik, portalınızın ana sayfasının (index) <title> etiketini doldurmak için kullanılır.
  • Başlıkta anahtar kelimelerin tam veya kısmi olarak eşleştirilmesi, arama sıralamasını iyileştirir.
  • Genellikle sayfa başlıklarınızın içeriği, arama sonuçlarının ilk satırı olarak gösterilir.
Sitenizde gezinmeyi kolaylaştırın Gezinmeyi ayarlama bölümünde açıklandığı gibi mantıklı bir gezinme yapısı tanımlayın.
  • Kullanıcıların yönünü korur.
  • Kullanıcıların istedikleri içeriği hızlı ve kolay bir şekilde bulmasına yardımcı olur.
İçerikte anahtar kelime öbeklerinin iyi bir karışımını kullanın. İçeriğinize alakalı ve anlamlı olduğunda anahtar kelimeler ekleyin. Anahtar kelime dizisinin sayfanızdaki belirginliği, arama sonuçlarında sayfa sıralamasını iyileştirebilir. Kullanıcıların içeriğinizi ararken kullanabileceği anahtar kelime dizelerini tahmin etmeye çalışın. Anahtar kelime doldurma (yani yalnızca arama sıralamasını iyileştirmek amacıyla anahtar kelimeleri aşırı kullanma) konusunda dikkatli olun. Bu durum, sitenizin arama motorları tarafından cezalandırılmasına neden olabilir. İçerik arayan kullanıcıların alakalı sonuçlar elde etme olasılığı artar.

Geliştirici topluluğu oluşturma

Facebook ve Twitter gibi standart sosyal medya kanalları üzerinden API topluluğunuzu tanıtmak için sosyal medyayı kullanın. API topluluğunuzdaki geliştiriciler arasında iletişimi ve etkileşimi teşvik eden bloglar ve forumlar yayınlayın.