JamesEsg.WebAPI.Template
1.1.1
dotnet add package JamesEsg.WebAPI.Template --version 1.1.1
NuGet\Install-Package JamesEsg.WebAPI.Template -Version 1.1.1
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="JamesEsg.WebAPI.Template" Version="1.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="JamesEsg.WebAPI.Template" Version="1.1.1" />
<PackageReference Include="JamesEsg.WebAPI.Template" />
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 JamesEsg.WebAPI.Template --version 1.1.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: JamesEsg.WebAPI.Template, 1.1.1"
#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 JamesEsg.WebAPI.Template@1.1.1
#: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=JamesEsg.WebAPI.Template&version=1.1.1
#tool nuget:?package=JamesEsg.WebAPI.Template&version=1.1.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
JamesEsg.WebAPI.Template
A lightweight .NET Web API project template with sensible defaults to speed up API development.
Features
Centralized exception handling
- Catches all unhandled exceptions in the pipeline.
- Returns a consistent JSON error response with
camelCaseproperties. - Displays detailed stack traces in Development.
- Shows generic error details in Production.
Customizable response format
- Uses an
ApiExceptionmodel for structured error messages. - Easy to extend for logging or custom error codes.
- Uses an
Minimal logging with Serilog
- Includes console and Seq sinks by default.
- Attaches the environment to every log for easy filtering in Seq.
- Configuration is supported via
appsettings.{ENVIRONMENT}.json
Getting Started
1. Create a new project from this template
dotnet new install ./JamesEsg.WebAPI.Template
dotnet new jamesesg-webapi -n MyApi
2. Run the API
cd MyApi
dotnet run
| Product | Versions 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. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- Serilog.AspNetCore (>= 9.0.0)
- Serilog.Enrichers.Environment (>= 3.0.1)
- Serilog.Expressions (>= 5.0.0)
- Serilog.Sinks.Seq (>= 9.0.0)
- Swashbuckle.AspNetCore (>= 6.4.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.