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ı izlemenizi önerir.

Kitlenizin ilgisini çekin

Kitlenizin görsel olarak ilgisini çeken ve onları daha fazla bilgi edinmeye teşvik eden içerikler ekleyin. API tüketicilerinin giriş yapmadan portalınızın bir bölümünü keşfetmesini sağlayın. API'lerinizi kullanarak uygulama derlemek üzere hızla çalışmaya başlayabilmeleri için self servis kayıt sağlayın.

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

OpenAPI Specifications bölümünden etkileşimli API belgelerini otomatik olarak oluşturarak kullanıcıların şunları yapabilmesini sağlayın:

  • 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ı makaleye bakın.

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

Kitlenize uygun ve deneyim seviyelerine dayalı kullanım örnekleri ve eğitimler sağlayın. Basit bir curl komut sırası gibi örneklerle gösterin veya daha ayrıntılı bir prosedürde adım adım ilerleyin.

Arama motoru optimizasyonunu (SEO) uygulama

İç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. Google'dan daha fazla bilgi ve 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şturun Kolay anlaşılır, kullanıcıların okuyabileceği URL'ler oluşturun. Portalınıza sayfa 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ı, kullanıcıların okuyabileceği bir biçimde sunar.
  • Sayfa URL'sinde tam veya kısmi anahtar kelime eşleme, 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ığı şekilde, 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ına (index) ait <title> etiketini doldurmak için kullanılır.
  • Başlıkta tam veya kısmi anahtar kelime eşleme, 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örüntülenir.
Sitenizde gezinmeyi kolaylaştırın Gezinmeyi ayarlama bölümünde açıklandığı şekilde mantıklı bir gezinme yapısı tanımlayın.
  • Kullanıcı odaklı olmasını sağlar.
  • Kullanıcıların istedikleri içeriği hızlı ve kolay bir şekilde bulmalarına yardımcı olur.
İçerik genelinde anahtar kelime öbeklerinin iyi bir karışımını kullanın. Alakalı ve mantıklı olduğunda anahtar kelimeleri içeriğinize ekleyin. Bir anahtar kelime dizesinin sayfanızda belirgin olması, arama sonuçlarındaki 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 unsurlarına, yani anahtar kelimeleri yalnızca arama sıralamasını iyileştirmek amacıyla aşırı kullanmamaya dikkat edin. Bu, sitenizin arama motorları tarafından cezalandırılmasına neden olabilir. İçerik arayan kullanıcıların alakalı isabetler alma olasılığı daha fazla olacaktır.

Geliştirici topluluğu oluşturma

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