Özel kaynak URL'lerini tanımlama

2025-05-20

.NET .NET Aspire içinde, uç noktaları açığa çıkaran kaynaklar, yalnızca çalışma zamanında bilinen konak ve bağlantı noktasını yapılandırır. Bu uç noktalardan birinde (özellikle panodan) belirli bir yola erişmeniz gerekiyorsa özel kaynak URL'leri tanımlayabilirsiniz. Ayrıca herhangi bir uç noktaya bağlı olmayan özel URL'ler de ekleyebilirsiniz. Tüm özel URL'ler yalnızca "çalıştır" modunda kullanılabilir, çünkü bunlar gösterge paneli kullanımına yöneliktir. Bu makalede özel URL'lerin nasıl tanımlanacağı gösterilmektedir.

Varsayılan uç nokta davranışı

Varsayılan olarak, .NET.NET Aspire proje kaynakları yapılandırılmış bir uç nokta için kaynağın ana bilgisayarını ve bağlantı noktasını belirlemek için Kestrel veya başlatma profilleri gibi mevcut yapılandırmaları kullanır ve uç noktalar her zaman panoda görüntülenir.

Benzer şekilde, API'yi kullanarak WithEndpoint uç noktaları açıkça kullanıma açabilirsiniz. Bu API, bir kaynağın ana bilgisayarını ve bağlantı noktasını belirtmenize olanak tanır. Bu, kaynağın varsayılan URL'sini oluşturmak için kullanılır. Varsayılan URL genellikle biçimindedir <scheme>://<host>:<port>. Sunucu bağlantı noktasını atlamak için aşağıdaki yöntemlerden birini kullanın.

Daha fazla bilgi için bkz . Uç nokta uzantısı yöntemleri.

Desteklenen kaynak türleri

Aşağıdaki kaynak türleri için özel kaynak URL'leri desteklenir:

Kaynak URL'lerini özelleştirme

Bir kaynağın özel URL'lerini tanımlamak için desteklenen herhangi bir kaynak oluşturucuda uygun WithUrl aşırı yüklemeyi, WithUrls veya WithUrlForEndpoint API'lerini kullanın. Aşağıdaki örnekte proje kaynağı için özel URL'nin nasıl ayarlanacağı gösterilmektedir:

var builder = DistributedApplication.CreateBuilder(args);

var api = builder.AddProject<Projects.AspireApp_Api>("api");

api.WithUrl("/admin", "Admin Portal");

builder.Build().Run();

Tavsiye

Herhangi bir URL'yi geçirmenize izin veren bir string aşırı yük vardır. Bu, kaynağın uç noktasıyla doğrudan ilişkili olmayan özel URL'leri tanımlamak için kullanışlıdır.

Önceki kod, api değişkenine bir proje referansı atar ve ardından Admin Portal güzergahı için özel bir URL oluşturur. WithUrl yöntemi, parametre olarak bir ReferenceExpression ve görünen adı alır. Elde edilen URL, aşağıdaki ekran görüntüsünde gösterildiği gibi panoda kullanılabilir:

Uç nokta URL'sini özelleştirme

Hem Scalar hem de Swagger , uç noktaların kullanılabilirliğini geliştiren yaygın API hizmetleridir. Bu hizmetlere bildirilen uç noktalara bağlı URL'ler aracılığıyla erişilir.

İlk ilişkili kaynak uç noktasının URL'sini özelleştirmek için WithUrlForEndpoint yöntemini kullanın.

Ayrı bir URL eklemek istiyorsanız (aynı uç nokta için bile) bir WithUrl veya ilişkilendirilmiş dize alan ReferenceExpression aşırı yüklemesini çağırmanız ya da URL'yi bağlamdaki WithUrls listesine eklemek için Urls çağırmanız gerekir.

var builder = DistributedApplication.CreateBuilder(args);

builder.AddProject<Projects.AspireApp_Api>("api")
    .WithUrlForEndpoint("https", url =>
    {
        url.DisplayText = "Scalar (HTTPS)";
        url.Url = "/scalar";
    });

builder.Build().Run();

Yukarıdaki örnekte, proje kaynağının api yapılandırılmış bir https uç noktası olduğu varsayılır. WithUrlForEndpoint yöntemi, uç noktayla ilişkili ResourceUrlAnnotation günceller. Bu durumda, Scalar (HTTPS) için görüntüleme metnini atar ve /scalar için URL'ye göreli yolu tanımlar.

Kaynak başlatıldığında, URL aşağıdaki ekran görüntüsünde gösterildiği gibi panoda kullanılabilir:

Alternatif olarak, bir Func<EndpointReference, ResourceUrlAnnotation>'ı geri arama fonksiyonu olarak kabul eden aşırı yüklemeyi kullanabilirsiniz. Bu, hedef EndpointReference örneklerde ayrıntılı bağlantılar belirtmenize olanak tanır.

Birden çok kaynak URL'lerini özelleştirme

Bir kaynağın birden çok URL'sini WithUrls özelleştirmek için yöntemini kullanın. Bu yöntem, bir kaynak için her biri kendi görüntüleme metni olan birden çok URL belirtmenize olanak tanır. Aşağıdaki örnekte, bir proje kaynağı için birden çok URL'nin nasıl ayarlanacağı gösterilmektedir:

var builder = DistributedApplication.CreateBuilder(args);

builder.AddProject<Projects.AspireApp_Api>("api")
    .WithUrls(context =>
    {
        foreach (var url in context.Urls)
        {
            if (string.IsNullOrEmpty(url.DisplayText))
            {
                url.DisplayText = $"API ({url.Endpoint?.Scheme?.ToUpper()})";
            }
        }
    });

builder.Build().Run();

Yukarıdaki kod, proje kaynağı için api tanımlanan URL'ler aracılığıyla yinelenir ve şemalı bir görüntüleme metni atar. Elde edilen URL'ler aşağıdaki ekran görüntüsünde gösterildiği gibi panoda bulunur:

.NET.NET Aspire kontrol paneli özelleştirilmiş ve isimlendirilmiş URL'ler.

Tavsiye

ResourceUrlsCallbackContext uç noktaları adlı temel kaynağa kolayca erişmenizi sağlayan bir uzantı yöntemini kullanıma sunar. GetEndpoint Bunu başarmak için bağlam örneğinde API'yi çağırın.

URL özelleştirme yaşam döngüsü

Uygulama modeli yaşam döngüsü sırasında, özellikle olay işleme sırasında, URL özelleştirme geri çağırmaları BeforeResourceStartedEvent çalıştırılır. Uç noktalarla ilişkili URL'ler etkin hale gelir ve uç noktanın kendisi etkinleştirildikten sonra panoda görünür. Uç noktalarla ilişkili olmayan URL'ler yalnızca kaynak "Çalışıyor" durumuna girdiğinde etkin hale gelir. Bu, uygulama kaynakları tam olarak çalışır durumda olduğunda tüm özel URL'lerin doğru bir şekilde temsil edilmesini ve kullanılabilir olmasını sağlar.

Aracılığıyla paylaş