Öğretici: Geliştirici portalına erişme ve bunları özelleştirme

Geliştirici Portalı , API 'lerinizin belgelerinde otomatik olarak oluşturulan ve tamamen özelleştirilebilir bir Web sitesidir. API tüketicilerinin API 'lerinizi keşfedebileceği, nasıl kullanılacağını ve nasıl erişim isteyeceğini burada bulabilirsiniz.

Bu öğreticide şunların nasıl yapıldığını öğreneceksiniz:

Geliştirici Portalında daha fazla ayrıntı için Azure API Management geliştirici portalına genel bakış ' aulaşabilirsiniz.

Önkoşullar

• Şu hızlı başlangıcı doldurun: Azure API Management örneği oluşturma
• Azure API Management örneğini içeri aktarın ve yayımlayın. Daha fazla bilgi için bkz. Içeri aktarma ve yayımlama

Kullanılabilirlik

Portala yönetici olarak erişin

Portalın yönetilen sürümüne erişmek için aşağıdaki adımları izleyin.

1. Azure portalAPI Management örneğinize gidin.
2. Üst gezinti çubuğunda Geliştirici Portalı düğmesini seçin. Portalın yönetici sürümüne sahip yeni bir tarayıcı sekmesi açılır.

Geliştirici portalı mimari kavramları

Portal bileşenleri, mantıksal olarak iki kategoriye ayrılabilir: kod ve içerik.

Kod

kod API Management geliştirici portalında GitHub deposunda tutulur ve şunları içerir:

• Pencere öğeleri-görsel öğeleri temsil eder ve HTML, JavaScript, stil oluşturma özelliği, ayarlar ve içerik eşlemeyi birleştirir. Örnekler, bir resim, metin paragrafı, form, API 'lerin listesi vb.
• Stil tanımları -Pencere öğelerinin nasıl Stillenebilir olduğunu belirtin
• Altyapı -Portal içeriğinden statik Web sayfaları oluşturur ve JavaScript 'te yazılmıştır
• Görsel düzenleyici -tarayıcı içi özelleştirme ve yazma deneyimine izin verir

Content

İçerik iki alt kategorilere ayrılmıştır: Portal içeriği ve API Management içeriği.

Portal içeriği portala özeldir ve şunları içerir:

• Sayfalar -Örneğin, giriş sayfası, API öğreticileri, blog gönderileri

• Medya -görüntüler, animasyonlar ve diğer dosya tabanlı içerikler

• Düzenler -bir URL ile eşleşen ve sayfaların nasıl görüntülendiğini tanımlayan şablonlar

• Stiller -yazı tipleri, renkler, kenarlıklar gibi stil tanımlarının değerleri

• Ayarlar -ayrıcalıklı simge, web sitesi meta verileri gibi yapılandırma

  Medya dışında Portal içeriği, JSON belgeleri olarak ifade edilir.

API Management içerik , API 'Ler, Işlemler, ürünler, abonelikler gibi varlıkları içerir.

Portalın yönetim arabirimini anlayın

Varsayılan içerik

Portala ilk kez erişiyorsanız, varsayılan içerik arka planda otomatik olarak sağlanır. Varsayılan içerik, portalın yeteneklerini göstermek ve portalınızı kişiselleştirmek için gereken özelleştirmeleri en aza indirmek için tasarlanmıştır. Azure API Management geliştirici portalına genel bakışbölümünde Portal içeriğine nelerin dahil olduğu hakkında daha fazla bilgi edinebilirsiniz.

Görsel düzenleyici

Portalın içeriğini görsel düzenleyiciyle özelleştirebilirsiniz.

• Sol taraftaki menü bölümleri; sayfaları, medyayı, düzenleri, menüleri, stilleri veya Web sitesi ayarlarını oluşturmanıza veya değiştirmenize olanak sağlar.
• Alt kısımdaki menü öğeleri, görünüm pencereleri (örneğin, mobil veya masaüstü) arasında geçiş yapmanızı, portalın öğelerini kimliği doğrulanmış veya anonim kullanıcılarla görüntülemeyi veya eylemleri kaydetmenizi veya geri almanızı sağlar.
• Bir sayfaya, artı işareti ile mavi simgesine tıklayarak satır ekleyin.
• Pencere öğeleri (örneğin, metin, görüntüler veya API listesi), artı işaretiyle bir gri simgeye basılarak eklenebilir.
• Sürükle ve bırak etkileşimi ile sayfadaki öğeleri yeniden düzenleyin.

Düzenler ve sayfalar

Düzenler sayfaların nasıl görüntüleneceğini tanımlar. Örneğin, varsayılan içerikte iki düzen vardır: biri giriş sayfasına, diğeri ise kalan tüm sayfalara uygulanır.

Bir düzen, URL şablonuyla sayfanın URL 'siyle eşleştirerek bir sayfaya uygulanır. Örneğin, URL şablonuna sahip bir düzen, /wiki/* /wiki/ URL 'deki segmentle birlikte her sayfaya uygulanır: /wiki/getting-started , /wiki/styles vb.

Önceki görüntüde, sayfa kırmızı olarak işaretlenirken düzene ait içerikler mavi olarak işaretlenir. Menü bölümleri sırasıyla işaretlenir.

Stil Kılavuzu

Stil Kılavuzu, tasarımcılara göz önünde bulundurularak oluşturulan bir paneldir. Portalınızdaki tüm görsel öğeleri fazla görmeye ve stillendirilmesini sağlar. Stil hiyerarşik bir öğelerdir; birçok öğe diğer öğelerden özellikleri miras alır. Örneğin düğme öğeleri metin ve arka plan renklerini kullanır. Bir düğmenin rengini değiştirmek için özgün renk türevini değiştirmeniz gerekir.

Bir varyantı düzenlemek için, onu seçin ve üzerine açılan kurşun kalem simgesini seçin. Açılır penceredeki değişiklikleri yaptıktan sonra kapatın.

Kaydet düğmesi

Portalda her değişiklik yaptığınızda, alt kısımdaki menüden Kaydet düğmesini seçerek veya [Ctrl] + [S] tuşlarına basarak el ile kaydetmeniz gerekir. Değişikliklerinizi kaydettiğinizde, değiştirilen içerik API Management hizmetinize otomatik olarak yüklenir.

Portalın içeriğini özelleştirme

Portalınızı ziyaretçi tarafından kullanılabilir yapmadan önce, otomatik olarak oluşturulan içeriği kişiselleştirmelisiniz. Önerilen değişiklikler, ana sayfanın düzenlerini, stillerini ve içeriğini içerir.

Giriş sayfası

Varsayılan giriş sayfası, yer tutucu içeriğiyle doldurulur. Bu içeriği içeren tüm bölümleri kaldırabilir ya da yapıyı koruyabilir ve öğeleri tek tek ayarlayabilirsiniz. Oluşturulan metin ve görüntüleri kendi kendinize değiştirin ve bağlantıların istenen konumlara işaret ettiğinizden emin olun. Giriş sayfasının yapısını ve içeriğini şu şekilde düzenleyebilirsiniz:

• Sayfa öğelerini, sitede istenen konuma sürükleyip bırakarak.
• İçeriği düzenlemek ve biçimlendirmek için metin ve başlık öğelerini seçme.
• Düğmelerinizin doğru konumlara işaret noktası doğrulanıyor.

Düzenler

Gezinti çubuğundaki otomatik olarak oluşturulan logoyu kendi görüntünüz ile değiştirin.

1. Geliştirici portalında, gezinti çubuğunun sol üst kısmında varsayılan contoso logosu ' nı seçin.
2. Düzenle simgesini seçin.
3. Ana bölümde kaynak' ı seçin.
4. Medya açılır penceresinde şunlardan birini seçin:
   • Kitaplığınızda zaten karşıya yüklenmiş bir görüntü veya
   • kullanılacak yeni bir resim dosyasını karşıya yüklemek için Upload veya
   • Bir logo kullanarak eklemek için yok ' u seçin.
5. Logo güncelleştirmeleri gerçek zamanlı olarak güncelleştirilir.
6. Medya kitaplığından çıkmak için açılan pencerelerin dışında ' yı seçin.
7. Kaydet’e tıklayın.

Stil oluşturma

Herhangi bir stili ayarlamanız gerekmez, ancak belirli öğeleri ayarlamayı düşünebilirsiniz. Örneğin, birincil rengi markanın rengiyle eş olacak şekilde değiştirebilirsiniz. Bunu iki şekilde yapabilirsiniz:

Genel site stili

1. Geliştirici portalında, sol araç çubuğundan Stiller simgesini seçin.
2. Renkler bölümünde, düzenlemek istediğiniz renk stili öğesini seçin.
3. Bu stil öğesinin Düzenle simgesine tıklayın.
4. Renk seçiciden rengi seçin veya altılık renk kodunu girin.
5. Renk ekle'ye tıklayarak başka bir renk öğesi ekleyin ve başka bir renk öğesi ekleyin.
6. Kaydet’e tıklayın.

Kapsayıcı stili

1. Geliştirici portalının ana sayfasında kapsayıcı arka planını seçin.
2. Düzenle simgesine tıklayın.
3. Açılır pencerede şunları ayarlayın:
   • Temizlemek için arka plan, bir görüntü, belirli bir renk veya gradyan.
   • Kapsayıcı boyutu, kenar boşluğu ve doldurma.
   • Kapsayıcı konumu ve yüksekliği.
4. Kapsayıcı ayarlarından çıkmak için açılır pencerelerin dışında öğesini seçin.
5. Kaydet’e tıklayın.

Özelleştirme örneği

Aşağıdaki videoda portalın içeriğini düzenlemeyi, web sitesinin görünümünü özelleştirmeyi ve değişiklikleri yayımlamayı gösterebilirsiniz.

Portalı yayımlama

Portalınızı ve en son değişikliklerini ziyaretçiler için kullanılabilir yapmak için yayımlamanız gerekir. Portalı portalın yönetim arabiriminde veya portaldan Azure portal.

Yönetim arabiriminden yayımlama

1. Kaydet simgesini seçerek değişikliklerinizi kaydetmeyi seçin.

2. Menenin İşlemler bölümünde Web sitesini yayımla'yı seçin. Bu işlem birkaç dakika sürebilir.

   

Azure portal'den yayımlama

1. uygulama Azure portal,uygulama örneğinize API Management gidin.

2. Sol menüde, Geliştirici portalı'nın altında Portala genel bakış'ı seçin.

3. Portala genel bakış penceresinde Yayımla'yı seçin.

   

Yayımlanan portalı ziyaret edin

Portalı yayımladikten sonra yönetim paneliyle aynı URL'de (örneğin, ) https://contoso-api.developer.azure-api.net erişebilirsiniz. Bunu dış ziyaretçi olarak ayrı bir tarayıcı oturumunda (gizli veya özel gözatma modunu kullanarak) görüntüleyebilirsiniz.

API'lere CORS ilkesi uygulama

Portal ziyaretçilerinin YERLEŞIK etkileşimli konsol aracılığıyla API'leri test sınasınaymalarını sağlamak için API'leriniz üzerinde CORS'yi (çıkış noktası arası kaynak paylaşımı) etkinleştirin. Ayrıntılar için bkz. Azure API Management portalı hakkında SSS.

Sonraki adımlar

Geliştirici portalı hakkında daha fazla bilgi edinmek için:

• Azure API Management geliştirici portalına genel bakış
• Kullanım dışı olan eski portaldan yeni geliştirici portalına geçiş.