Carter.Analyzers
8.2.1
dotnet add package Carter.Analyzers --version 8.2.1
NuGet\Install-Package Carter.Analyzers -Version 8.2.1
<PackageReference Include="Carter.Analyzers" Version="8.2.1" />
paket add Carter.Analyzers --version 8.2.1
#r "nuget: Carter.Analyzers, 8.2.1"
// Install Carter.Analyzers as a Cake Addin #addin nuget:?package=Carter.Analyzers&version=8.2.1 // Install Carter.Analyzers as a Cake Tool #tool nuget:?package=Carter.Analyzers&version=8.2.1
Carter
Carter is a framework that is a thin layer of extension methods and functionality over ASP.NET Core allowing the code to be more explicit and most importantly more enjoyable.
For a better understanding, take a good look at the samples inside this repo. The samples demonstrate usages of elegant extensions around common ASP.NET Core types as shown below.
Other extensions include:
Validate<T> / ValidateAsync<T>
- FluentValidation extensions to validate incoming HTTP requests which is not available with ASP.NET Core Minimal APIs.BindFile/BindFiles/BindFileAndSave/BindFilesAndSave
- Allows you to easily get access to a file/files that has been uploaded. Alternatively you can callBindFilesAndSave
and this will save it to a path you specify.- Routes to use in common ASP.NET Core middleware e.g.,
app.UseExceptionHandler("/errorhandler");
. IResponseNegotiator
s allow you to define how the response should look on a certain Accept header(content negotiation). Handling JSON is built in the default response but implementing an interface allows the user to choose how they want to represent resources.- All interface implementations for Carter components are registered into ASP.NET Core DI automatically. Implement the interface and off you go.
Releases
Join our Slack Channel
Routing
Carter uses IEndpointRouteBuilder
routing and all the extensions IEndpointConventionBuilder
offers also known as Minimal APIs. For example you can define a route with authorization required like so:
app.MapGet("/", () => "There's no place like 127.0.0.1").RequireAuthorization();
Where does the name "Carter" come from?
I have been a huge fan of, and core contributor to Nancy, the best .NET web framework, for many years, and the name "Nancy" came about due to it being inspired from Sinatra the Ruby web framework. Frank Sinatra had a daughter called Nancy and so that's where it came from.
I was also trying to think of a derivative name, and I had recently listened to the song Empire State of Mind where Jay-Z declares he is the new Sinatra. His real name is Shaun Carter so I took Carter and here we are!
CI Builds
If you'd like to try the latest builds from the master branch add https://f.feedz.io/carter/carter/nuget/index.json
to your NuGet.config and pick up the latest and greatest version of Carter.
Getting Started
You can get started using either the template or by adding the package manually to a new or existing application.
Template
https://www.nuget.org/packages/CarterTemplate/
Install the template -
dotnet new install CarterTemplate
Create a new application using template -
dotnet new carter -n MyCarterApp -o MyCarterApp
Go into the new directory created for the application
cd MyCarterApp
Run the application -
dotnet run
Package
https://www.nuget.org/packages/Carter
Create a new empty ASP.NET Core application -
dotnet new web -n MyCarterApp
Change into the new project location -
cd ./MyCarterApp
Add Carter package -
dotnet add package carter
Modify your Program.cs to use Carter
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddCarter();
var app = builder.Build();
app.MapCarter();
app.Run();
- Create a new Module
public class HomeModule : ICarterModule
{
public void AddRoutes(IEndpointRouteBuilder app)
{
app.MapGet("/", () => "Hello from Carter!");
}
}
- Run the application -
dotnet run
Sample
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddSingleton<IActorProvider, ActorProvider>();
builder.Services.AddCarter();
var app = builder.Build();
app.MapCarter();
app.Run();
public class HomeModule : ICarterModule
{
public void AddRoutes(IEndpointRouteBuilder app)
{
app.MapGet("/", () => "Hello from Carter!");
app.MapGet("/qs", (HttpRequest req) =>
{
var ids = req.Query.AsMultiple<int>("ids");
return $"It's {string.Join(",", ids)}";
});
app.MapGet("/conneg", (HttpResponse res) => res.Negotiate(new { Name = "Dave" }));
app.MapPost("/validation", HandlePost);
}
private IResult HandlePost(HttpContext ctx, Person person, IDatabase database)
{
var result = ctx.Request.Validate(person);
if (!result.IsValid)
{
return Results.UnprocessableEntity(result.GetFormattedErrors());
}
var id = database.StorePerson(person);
ctx.Response.Headers.Location = $"/{id}";
return Results.StatusCode(201);
}
}
public record Person(string Name);
public interface IDatabase
{
int StorePerson(Person person);
}
public class Database : IDatabase
{
public int StorePerson(Person person)
{
//db stuff
}
}
Configuration
As mentioned earlier Carter will scan for implementations in your app and register them for DI. However, if you want a more controlled app, Carter comes with a CarterConfigurator
that allows you to register modules, validators and response negotiators manually.
Carter will use a response negotiator based on System.Text.Json
, though it provides for custom implementations via the IResponseNegotiator
interface. To use your own implementation of IResponseNegotiator
(say, CustomResponseNegotiator
), add the following line to the initial Carter configuration, in this case as part of Program.cs
:
builder.Services.AddCarter(configurator: c =>
{
c.WithResponseNegotiator<CustomResponseNegotiator>();
c.WithModule<MyModule>();
c.WithValidator<TestModelValidator>()
});
Here again, Carter already ships with a response negotiator using Newtonsoft.Json
, so you can wire up the Newtonsoft implementation with the following line:
builder.Services.AddCarter(configurator: c =>
{
c.WithResponseNegotiator<NewtonsoftJsonResponseNegotiator>();
});
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Microsoft.CodeAnalysis.CSharp (>= 4.7.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Carter.Analyzers:
Package | Downloads |
---|---|
Carter
Carter is framework that is a thin layer of extension methods and functionality over ASP.NET Core allowing code to be more explicit and most importantly more enjoyable. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
8.2.1 | 72,973 | 6/6/2024 |