Geliştirici portalına genel bakış

Geliştirici portalı, API'lerinizin belgeleriyle birlikte otomatik olarak oluşturulmuş, tamamen özelleştirilebilir bir web sitesidir. BURADA API tüketicileri API'lerinizi bulabilir, bunların nasıl kullanılacağını öğrenebilir, erişim isteyebilir ve bunları deneyebilir.

Bu makalede açıklandığı gibi, geliştirici portalını özel senaryolarınız için özelleştirebilir ve genişletebilirsiniz.

geliştirici portalı API Management

Kullanılabilirlik

Önemli

Bu özellik, API Management Premium, Standart, Temel ve Geliştirici katmanlarında kullanılabilir.

Eski portaldan geçiş

Önemli

Eski geliştirici portalı artık kullanım dışıdır ve yalnızca güvenlik güncelleştirmelerini alır. Tüm API Management hizmetlerinden kaldırılacağı Ekim 2023'te kullanımdan kaldırılana kadar her zamanki gibi kullanmaya devam edebilirsiniz.

Yeni geliştirici portalına geçiş , ayrılmış belge makalesinde açıklanmıştır.

Yönetilen portalı özelleştirme ve stil oluşturma

API Management hizmetiniz yerleşik, her zaman güncel, yönetilen bir geliştirici portalı içerir. Bu arabirime Azure portal arabiriminden erişebilirsiniz.

Yerleşik sürükleyip bırakma görsel düzenleyicisi aracılığıyla yönetilen portalı özelleştirin ve stil oluşturun:

  • Sayfaları, medyayı, düzenleri, menüleri, stilleri veya web sitesi ayarlarını değiştirmek için görsel düzenleyiciyi kullanın.

  • Portalın kullanıma yönelik olarak desteklediği metin, resim, düğme ve diğer nesneleri eklemek için yerleşik pencere öğesinden yararlanın.

  • Portal içeriğinin API Management örneğinizde yapılandırılmış farklı kullanıcılara ve gruplara nasıl görüneceğini denetleyin. Örneğin, belirli sayfaları yalnızca belirli ürünlerle ilişkili gruplara veya belirli API'lere erişebilen kullanıcılara görüntüleyin.

Not

Yönetilen geliştirici portalı güncelleştirmeleri otomatik olarak alır ve uygular. Kaydettiğiniz ancak geliştirici portalında yayımlamadığınız değişiklikler bir güncelleştirme sırasında bu durumda kalır.

Portal işlevselliğini genişletme seçenekleri

Bazı durumlarda, yönetilen geliştirici portalında sağlanan özelleştirme ve stil seçeneklerinin ötesinde işlevlere ihtiyacınız olabilir. İlk çalıştırmada desteklenmeyen özel mantık uygulamanız gerekiyorsa , birkaç seçeneğiniz vardır:

  • Küçük özelleştirmeler için tasarlanmış bir geliştirici portalı pencere öğesi aracılığıyla doğrudan özel HTML ekleyin; örneğin, bir forma HTML ekleyin veya video oynatıcı ekleyin. Özel kod bir satır içi çerçevede (IFrame) işlenir.
  • Daha karmaşık özel portal özellikleri geliştirmek ve eklemek için özel bir pencere öğesi oluşturun ve karşıya yükleyin.
  • Yalnızca geliştirici portalı kod tabanının çekirdeğinde değişiklik yapmanız gerekiyorsa portalı kendi kendine barındırın. Bu seçenek gelişmiş yapılandırma gerektirir. Azure Desteği'nin yardımı yalnızca şirket içi barındırılan portalların temel kurulumuyla sınırlıdır.

Not

API Management geliştirici portalı kod tabanı GitHub'da tutulacağından, istediğiniz zaman sorunları açabilir ve API Management ekibinin yeni işlevleri birleştirmesi için çekme isteklerinde bulunabilirsiniz.

Sonraki adımlar

Geliştirici portalı hakkında daha fazla bilgi edinin:

Diğer kaynaklara göz atın: