Aracılığıyla paylaş


Microsoft.AspNetCore.Mvc.ApiExplorer Ad Alanı

Denetleyicilerin ve eylemlerin listesi ve BUNLARıN URL'leri gibi meta verilerin bulunmasına olanak sağlayan türler sağlar. Bu türler, OpenAPI kullanarak API'leri documeting için yararlıdır.

Sınıflar

ApiConventionNameMatchAttribute

Api kural yönteminin veya parametresinin eşleşen davranışını ada göre belirler. ApiConventionNameMatchBehavior seçeneğine tıklayın. .

ApiConventionResult

API kuralı aracılığıyla bir eylem yöntemiyle ilişkili meta veriler.

ApiConventionTypeMatchAttribute

Api kuralı parametresinin türe göre eşleşen davranışını belirler. ApiConventionTypeMatchBehavior seçeneğine tıklayın. .

ApiDescription

Bu uygulama tarafından kullanıma sunulan bir API'yi temsil eder.

ApiDescriptionExtensions

için ApiDescriptionuzantı yöntemleri.

ApiDescriptionGroup

İlgili api'lerden oluşan bir grubu temsil eder.

ApiDescriptionGroupCollection

Önbelleğe alınmış koleksiyonu ApiDescriptionGroup.

ApiDescriptionGroupCollectionProvider

bir koleksiyonuna ApiDescriptionGrouperişim sağlar.

ApiDescriptionProviderContext

Sağlayıcılar için ApiDescription bir bağlam nesnesi.

ApiParameterDescription

API'ye girişin meta veri açıklaması.

ApiParameterRouteInfo

bir için ApiParameterDescriptionyönlendirme bilgilerinin meta veri açıklaması.

ApiRequestFormat

İsteğin gövdesi için olası bir biçim.

ApiResponseFormat

Bir için ApiResponseTypeolası biçim.

ApiResponseType

tarafından ApiResponseFormatsbiçimlendirilmiş yanıt gövdesinin olası türü.

DefaultApiDescriptionProvider

tarafından ControllerActionDescriptortemsil edilen eylemler için sağlayıcısını ApiDescription uygular.

Arabirimler

IApiDefaultResponseMetadataProvider

Diğer IApiResponseMetadataProvider örneklerin kapsamına alınmayan tüm HTTP durum kodları için bir dönüş türü sağlar.

IApiDescriptionGroupCollectionProvider

bir koleksiyonuna ApiDescriptionGrouperişim sağlar.

IApiDescriptionGroupNameProvider

Bir ApiDescriptioniçin grup adı meta verilerini temsil eder.

IApiDescriptionProvider

Örnekleri belirtmek ApiDescription için bir sözleşme tanımlar.

IApiDescriptionVisibilityProvider

bir ApiDescriptioniçin görünürlük meta verilerini temsil eder.

IApiRequestFormatMetadataProvider

bir IApiDescriptionProvideristek biçimi hakkında meta veri bilgileri sağlar.

IApiRequestMetadataProvider

Eylem tarafından kullanılamayabilecek bir dizi olası içerik türü sağlar.

IApiResponseMetadataProvider

Eylemin başarıyla yürütülmesiyle döndürülen bir dönüş türü, durum kodu ve olası içerik türleri kümesi sağlar.

IApiResponseTypeMetadataProvider

bir IApiDescriptionProvideryanıt biçimi hakkında meta veri bilgileri sağlar.

Numaralandırmalar

ApiConventionNameMatchBehavior

Bir kural parametresinin veya yönteminin adıyla eşleştirme davranışı.

ApiConventionTypeMatchBehavior

Bir kural parametresinin türüyle eşleştirme davranışı.

Açıklamalar

Swagger'a (OpenAPI) giriş için Swagger / OpenAPI ile web API'si belgelerine ASP.NET Core.