Helper.SwaggerExtension.AdvancedDocument 1.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
Additional Details

This is removed

There is a newer version of this package available.
See the version list below for details. 
dotnet add package Helper.SwaggerExtension.AdvancedDocument --version 1.0.0                

                    
                

            
NuGet\Install-Package Helper.SwaggerExtension.AdvancedDocument -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Helper.SwaggerExtension.AdvancedDocument" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Helper.SwaggerExtension.AdvancedDocument --version 1.0.0                

                    
                

            
#r "nuget: Helper.SwaggerExtension.AdvancedDocument, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Helper.SwaggerExtension.AdvancedDocument as a Cake Addin
#addin nuget:?package=Helper.SwaggerExtension.AdvancedDocument&version=1.0.0

// Install Helper.SwaggerExtension.AdvancedDocument as a Cake Tool
#tool nuget:?package=Helper.SwaggerExtension.AdvancedDocument&version=1.0.0

ASP.NET Core Swagger Helper

Bu doküman, SwaggerDocumentBasic yapısını ve diğer yardımcı sınıfları kullanarak bir ASP.NET Core projesinde Swagger desteğini nasıl entegre edebileceğinizi gösterir. Swagger, API'lerinizi belgelemenin ve test etmenin etkili bir yoludur.

Swagger Desteği İçin Yardımcı Classlar

  • Annotation Desteği
  • XML Yorum Desteği
  • JWT Güvenlik Desteği
  • Güvenlik Gereksinimleri Desteği

Entegrasyon

var swaggerDoc = new SwaggerDocumentBasic.Builder().SetVersion("v1")
.SetTitle("My API")
.SetDescription("API Description")
.SetContactName("Contact Name") .SetContactEmail("contact@example.com")
.SetLicenseName("MIT") .SetLicenseUrl("https://opensource.org/licenses/MIT")
.Build(); 

var apiOptions = new ApiDefaultOpt.Builder()
.AddAnnatationSupport(true)
.AddXmlDocSupport(true)
.AddSwaggerJwtSecuritySupport(true) .AddSwaggerSecuritySupport(true) .AddExceptionMiddlewareEnabled(true)
.Build(); 
services.AddMyAwesomeSwaggerSupport(swaggerDoc, apiOptions);

Midlaware Olarak Eklenmesi

//Burdan başlayıp
var apiOptions = new ApiDefaultOpt.Builder().
AddExceptionMiddlewareEnabled(true).Build(); 
app.UseMyAwesomeSwaggerSupport(apiOptions); 
//Buraya kadar olan kısım

app.UseRouting(); 
app.UseAuthentication(); 
app.UseAuthorization(); 
app.UseEndpoints(endpoints => { endpoints.MapControllers(); });

XML Yorum Desteği

  • Projenize XML yorum dosyalarını eklemek ve Swagger dokümantasyonunda bu yorumları kullanmak için şu adımları izleyebilirsiniz:
  • Proje Dosyasını Düzenleyin: Projenizin .csproj dosyasına aşağıdaki kodu ekleyin:
<PropertyGroup>
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
    <NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>
  • Swagger Konfigürasyonunu Güncelleyin: Swagger servislerini eklerken ApiDefaultOpt sınıfında IsAddXmlDocSupport özelliğini true olarak ayarlayın.

JWT Güvenlik Desteği

JWT güvenlik desteği eklemek için IsAddSwaggerJwtSecuritySupport özelliğini true olarak ayarlayın ve Swagger güvenlik gereksinimlerini yapılandırın.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.