Şablonları kullanarak Azure API Management Geliştirici Portalını Özelleştirme

Azure API Management'ta geliştirici portalını özelleştirmek için kullanılabilecek üç temel yöntem vardır:

Şablonlar, sistem tarafından oluşturulan geliştirici portalı sayfalarının (örneğin, API belgeleri, ürünler, Kullanıcı kimlik doğrulaması vb.) içeriğini özelleştirmek için kullanılır. Dotlikit sözdizimi ve sağlanan yerelleştirilmiş dize kaynakları, simgeler ve sayfa denetimleri kullanılarak sayfaların içeriğini uygun gördüğünüz şekilde yapılandırmak için harika bir esneklik vardır.

Not

Bu belge içeriği kullanım dışı olan geliştirici portalı ile ilgilidir. Bu hizmeti, her zamanki gibi kullanmaya devam edebilirsiniz, bu, tüm API Management hizmetlerinden kaldırılacak olan 2023 Ekim 'de devre dışı kalır. Kullanımdan kaldırılan Portal yalnızca kritik güvenlik güncelleştirmelerini alacaktır. Daha ayrıntılı bilgi için aşağıdaki makalelere bakın:

Kullanılabilirlik

Önemli

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

Geliştirici portalı şablonlarına genel bakış

Şablonları düzenleyici, yönetici olarak oturum açarken Geliştirici portalından yapılır. Önce Azure portal açın ve API Management örneğinizin hizmet araç çubuğundan Geliştirici Portalı ' na tıklayın.

Geliştirici portalı şablonlarına erişmek için sol taraftaki Özelleştir simgesine tıklayarak özelleştirme menüsünü görüntüleyin ve Şablonlar' a tıklayın.

Özelleştirme menüsünü göstermek için Özelleştir simgesini vurgulayan ekran görüntüsü.

Şablonlar listesi, geliştirici portalındaki farklı sayfaları kapsayan birkaç şablon kategorisini görüntüler. Her şablon farklıdır, ancak bunları düzenleme ve değişiklikleri yayımlama adımları aynıdır. Bir şablonu düzenlemek için şablonun adına tıklayın.

Geliştirici portalı şablonları

Bir şablona tıkladığınızda bu şablon tarafından özelleştirilebilen geliştirici portalı sayfasına gidersiniz. Bu örnekte, ürün listesi şablonu görüntülenir. Ürün listesi şablonu, ekranın kırmızı dikdörtgenle belirtilen alanını denetler.

Ürün listesi şablonu

Kullanıcı profili şablonları gibi bazı şablonlar, aynı sayfanın farklı parçalarını özelleştirir.

Kullanıcı profili şablonları

Her geliştirici portalı şablonunun Düzenleyicisi, sayfanın alt kısmında iki bölümden oluşur. Sol tarafta, şablonun düzenlenme bölmesi görüntülenir ve sağ taraftaki şablon için veri modeli görüntülenir.

Şablon düzenlemesi bölmesi, geliştirici portalındaki karşılık gelen sayfanın görünümünü ve davranışını denetleyen biçimlendirmeyi içerir. Şablondaki biçimlendirme, Dotlikit sözdizimini kullanır. Dotlikit için popüler bir düzenleyici, tasarımcılar Için Dotlikit' dir. Düzen sırasında şablonda yapılan tüm değişiklikler tarayıcıda gerçek zamanlı olarak görüntülenir, ancak şablonu kaydedip yayımlaana kadar müşterilerinize görülemez.

Şablon biçimlendirmesi

Şablon verileri bölmesi, belirli bir şablonda kullanıma sunulan varlıkların veri modeline kılavuzluk sağlar. Geliştirici Portalında Şu anda görüntülenen canlı verileri görüntüleyerek bu kılavuzu sağlar. Şablon bölmeleri, şablon verileri bölmesinin sağ üst köşesindeki dikdörtgene tıklayarak genişletebilirsiniz.

Şablon veri modeli

Önceki örnekte, aşağıdaki örnekte gösterildiği gibi, şablon verileri bölmesinde görüntülenen verilerden alınan Geliştirici Portalında iki ürün görüntülenir:

{
    "Paging": {
        "Page": 1,
        "PageSize": 10,
        "TotalItemCount": 2,
        "ShowAll": false,
        "PageCount": 1
    },
    "Filtering": {
        "Pattern": null,
        "Placeholder": "Search products"
    },
    "Products": [
        {
            "Id": "56ec64c380ed850042060001",
            "Title": "Starter",
            "Description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.",
            "Terms": "",
            "ProductState": 1,
            "AllowMultipleSubscriptions": false,
            "MultipleSubscriptionsCount": 1
        },
        {
            "Id": "56ec64c380ed850042060002",
            "Title": "Unlimited",
            "Description": "Subscribers have completely unlimited access to the API. Administrator approval is required.",
            "Terms": null,
            "ProductState": 1,
            "AllowMultipleSubscriptions": false,
            "MultipleSubscriptionsCount": 1
        }
    ]
}

Ürün listesi şablonundaki biçimlendirme, bilgileri ve her bir ürüne yönelik bir bağlantıyı göstermek üzere ürünlerin toplanması yoluyla istenen çıktıyı sağlamak üzere verileri işler. <search-control> <page-control> İşaretlemede ve öğelerini aklınızda yapın. Bu denetim sayfada arama ve sayfalama denetimleri görüntülenir. ProductsStrings|PageTitleProducts , sayfanın üst bilgi metnini içeren yerelleştirilmiş bir dize başvurusudur h2 . Geliştirici portalı şablonlarında kullanılabilecek dize kaynakları, sayfa denetimleri ve simgelerin bir listesi için, bkz. API Management geliştirici portalı şablonları başvurusu.

<search-control></search-control>
<div class="row">
    <div class="col-md-9">
        <h2>{% localized "ProductsStrings|PageTitleProducts" %}</h2>
    </div>
</div>
<div class="row">
    <div class="col-md-12">
    {% if products.size > 0 %}
    <ul class="list-unstyled">
    {% for product in products %}
        <li>
            <h3><a href="/products/{{product.id}}">{{product.title}}</a></h3>
            {{product.description}}
        </li>
    {% endfor %}
    </ul>
    <paging-control></paging-control>
    {% else %}
    {% localized "CommonResources|NoItemsToDisplay" %}
    {% endif %}
    </div>
</div>

Bir şablonu kaydetmek için

Bir şablonu kaydetmek için şablon düzenleyicisinde Kaydet ' e tıklayın.

Şablonu kaydetme

Kayıtlı değişiklikler yayımlanana kadar Geliştirici Portalında canlı değildir.

Şablon yayımlamak için

Kaydedilmiş şablonlar tek tek veya hepsi birlikte yayımlanabilir. Tek bir şablonu yayımlamak için şablon düzenleyicisinde Yayımla ' ya tıklayın.

Şablonu yayımlama

Onaylamak için Evet ' e tıklayın ve şablonu Geliştirici Portalında canlı hale getirin.

Şablonu canlı hale getirmek için Evet ' i seçtiğiniz yeri gösteren ekran görüntüsü.

Kaldırılmış olan tüm şablon sürümlerini yayımlamak için şablonlar listesinde Yayımla ' ya tıklayın. Yayımdan kaldırılan şablonlar, şablon adından sonra bir yıldız işaretiyle atanır. Bu örnekte, ürün listesi ve ürün şablonları yayımlanıyor.

Şablonları yayımlama

Onaylamak için Özelleştirmeleri Yayımla ' ya tıklayın.

Yayımlamayı Onayla

Yeni yayınlanan şablonlar, Geliştirici Portalında hemen etkili olur.

Bir şablonu önceki sürüme geri dönüştürmek için

Bir şablonu önceki yayımlanmış sürüme geri dönüştürmek için şablon düzenleyicisinde geri çevir ' e tıklayın.

Bir şablonu döndürmemek için kullandığınız simgeyi vurgulayan ekran görüntüsü.

Onaylamak için Evet’e tıklayın.

Değişiklikleri onaylamak için Evet ' i seçtiğiniz yeri gösteren ekran görüntüsü.

Bir şablonun daha önce yayımlanmış olan sürümü, bir önceki olarak, iade işlemi tamamlandıktan sonra Geliştirici Portalında canlı olur.

Bir şablonu varsayılan sürüme geri yüklemek için

Şablonları varsayılan sürümüne geri yüklemek iki adımlı bir işlemdir. Önce şablonların geri yüklenmesi gerekir ve ardından geri yüklenen sürümlerin yayımlanması gerekir.

Tek bir şablonu varsayılan sürüme geri yüklemek için şablon düzenleyicisinde geri yükle ' ye tıklayın.

Şablonu tekrar çevir

Onaylamak için Evet’e tıklayın.

Confirm

Tüm şablonları varsayılan sürümlerine geri yüklemek için şablon listesinde varsayılan şablonları geri yükle ' ye tıklayın.

Şablonları geri yükleme

Geri yüklenen şablonlar, bir şablon yayımlamak içiniçindeki adımları izleyerek tek seferde veya her bir kez yayımlanmalıdır.

Sonraki adımlar

Geliştirici portalı şablonları, dize kaynakları, simgeler ve sayfa denetimleri için başvuru bilgileri için bkz. API Management geliştirici portalı şablonları başvurusu.