Pipoburgos.SharedKernel.Api.OpenApi
11.0.0.2
dotnet add package Pipoburgos.SharedKernel.Api.OpenApi --version 11.0.0.2
NuGet\Install-Package Pipoburgos.SharedKernel.Api.OpenApi -Version 11.0.0.2
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="Pipoburgos.SharedKernel.Api.OpenApi" Version="11.0.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Pipoburgos.SharedKernel.Api.OpenApi" Version="11.0.0.2" />
<PackageReference Include="Pipoburgos.SharedKernel.Api.OpenApi" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Pipoburgos.SharedKernel.Api.OpenApi --version 11.0.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Pipoburgos.SharedKernel.Api.OpenApi, 11.0.0.2"
#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.
#:package Pipoburgos.SharedKernel.Api.OpenApi@11.0.0.2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Pipoburgos.SharedKernel.Api.OpenApi&version=11.0.0.2
#tool nuget:?package=Pipoburgos.SharedKernel.Api.OpenApi&version=11.0.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
The following code demonstrates basic usage of SharedKernel api.
appsettings.json
{
"AllowedHosts": "",
"Origins": [
"https://localhost/"
],
"SmtpSettings": {
"MailServer": "smtp",
"MailPort": 587,
"SenderName": "SharedKernel@SharedKernel.com",
"Sender": "SharedKernel@SharedKernel.com",
"Password": "SharedKernel"
},
"OpenApiOptions": {
"Title": "SharedKernel",
"AppName": "SharedKernel",
"Name": "SharedKernel",
"XmlDocumentationFile": "SharedKernel.Api.xml"
},
"ConnectionStrings": {
"PaymentConnection": "Server=.;Database=Payment;Trusted_Connection=True;MultipleActiveResultSets=true;Application Name=Payment;",
"PurchasingConnection": "Server=.;Database=Purchasing;Trusted_Connection=True;MultipleActiveResultSets=true;Application Name=Purchasing;"
},
"RabbitMq": {
"Username": "guest",
"Password": "guest",
"Hostname": "localhost",
"port": "5672"
},
"RedisCacheOptions": {
"ConnectionString": "localhost:6379",
"Configuration": "localhost:6379",
"InstanceName": "sharedKernel"
},
}
Startup.cs
See register module information
public class Startup
{
public class Startup
{
private const string CorsPolicy = "CorsPolicy";
private IConfiguration Configuration { get; }
public Startup(IConfiguration configuration)
{
Configuration = configuration;
}
public void ConfigureServices(IServiceCollection services)
{
services
.AddSharedKernel()
.AddSharedKernelApi<FluentApiSampleValidator>(CorsPolicy, Configuration.GetSection("Origins").Get<string[]>())
.AddSharedKernelHealthChecks()
.AddSharedKernelOpenApi(Configuration)
// Cache
.AddRedisDistributedCache(Configuration)
// .AddInMemoryCache()
.AddInMemoryCommandBus()
.AddInMemoryQueryBus()
// Event bus
.AddRabbitMqEventBus(Configuration)
// .AddInMemoryEventBus()
//.AddRedisEventBus(Configuration)
// Add modules
.AddPaymentModule(Configuration, "PaymentConnection")
.AddPurchasingModule(Configuration, "PurchasingConnection")
// Register all domain event subscribers
.AddDomainEventSubscribers();
}
public void Configure(IApplicationBuilder app, IOptions<OpenApiOptions> options)
{
// Other usages
app.UseCors(CorsPolicy);
// Other usages
app
.UseEndpoints(endpoints =>
{
endpoints.MapHealthChecks("/health", new HealthCheckOptions
{
ResponseWriter = UIResponseWriter.WriteHealthCheckUIResponse
});
endpoints.MapControllers();
})
.UseSharedKernelMetrics()
.UseSharedKernelOpenApi(options);
}
}
}
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net11.0 is compatible. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net11.0
- MicroElements.AspNetCore.OpenApi.FluentValidation (>= 7.3.0-beta.1)
- MicroElements.Swashbuckle.FluentValidation (>= 7.3.0-beta.1)
- Microsoft.AspNetCore.OpenApi (>= 11.0.0)
- Microsoft.OpenApi (>= 3.11.0)
- Pipoburgos.SharedKernel.Api (>= 11.0.0.2)
- Swashbuckle.AspNetCore (>= 11.0.1)
- Swashbuckle.AspNetCore.Filters (>= 10.0.1)
- Swashbuckle.AspNetCore.Swagger (>= 11.0.1)
- Swashbuckle.AspNetCore.SwaggerUI (>= 11.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.