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

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

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

Kitlenizin ilgisini çekin

Kitlenizin ilgisini görsel olarak çeken ve daha fazla bilgi edinmelerini sağlayan içerikler ekleyin. API tüketicilerinin, oturum açmadan portalınızın bir bölümünü keşfetmelerini sağlayın. API'lerinizi kullanarak uygulama oluşturmak için hızlıca çalışmaya başlayabilmeleri amacıyla self servis kayıt sunun.

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

Kullanıcıların şunları yapmasını sağlamak için OpenAPI spesifikasyonlarınızdan otomatik olarak etkileşimli API dokümanları oluşturun:

  • API hakkında bilgi edinin
  • 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.

Birincil öğrenme yollarını ele alın

Kitlenizle alakalı ve deneyim düzeylerine göre kullanım alanı örnekleri ve eğitimleri sağlayın. Basit bir curl komutu dizisi gibi örneklerle veya daha ayrıntılı bir prosedürde adım adım açıklamalı olarak gösterin.

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 oluştururken aşağıdaki en iyi uygulamalardan yararlanın. Daha fazla bilgi ve Google'ın ek yönergeleri 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, kullanıcıların okuyabileceği URL'ler oluşturun. Sayfa oluşturma bölümünde açıklandığı gibi, portalınıza sayfa eklerken kullanıcı dostu bir sayfa URL'si tanımlayın.
  • Sayfanın amacını kullanıcılar tarafından 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ı (index) için <title> etiketini doldurmak amacıyla kullanılır.
  • Başlıktaki anahtar kelime eşleşmesi tam veya kısmi olursa arama sıralaması iyileşir.
  • 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ü belirler.
  • Kullanıcıların istedikleri içeriği hızlı ve kolay bir şekilde bulmalarına yardımcı olur.
İçerikte anahtar kelime öbeklerinin iyi bir karışımını kullanın Alakalı olduğunda ve bunu yapmak mantıklı olduğunda içeriğinize anahtar kelimeler ekleyin. Sayfanızdaki bir anahtar kelime dizesinin belirgin olması, arama sonuçlarındaki sayfa sıralamasını iyileştirebilir. Kullanıcıların içeriğinizi ararken kullanabileceği anahtar kelime dizeleri tahmin etmeye çalışın. Anahtar kelime doldurma (yalnızca arama sıralamasını iyileştirmek amacıyla anahtar kelimeleri aşırı kullanma) yapmamaya dikkat edin. 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ı aracılığıyla 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.