AddXMapEndpoints 1.1.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package AddXMapEndpoints --version 1.1.0
NuGet\Install-Package AddXMapEndpoints -Version 1.1.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="AddXMapEndpoints" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add AddXMapEndpoints --version 1.1.0
#r "nuget: AddXMapEndpoints, 1.1.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 AddXMapEndpoints as a Cake Addin
#addin nuget:?package=AddXMapEndpoints&version=1.1.0

// Install AddXMapEndpoints as a Cake Tool
#tool nuget:?package=AddXMapEndpoints&version=1.1.0

XMaps Enpoints

This extension allows you to auto-generate Minimal API into your WebApplication.

To use this �magic� feature just follow those siple steps:

  1. Add the extension method inside your Program.cs class:

    app.AddXMapEndpoints(); // It's a kind of magic...

  2. Decorate desired DTO�s with the �AddXMapEndpoints� attribute

    [AddXMapEndpoints]

    public class MyDto

How it works:

Decorating a DTO with the �AddXMapEndpoints� attribute will create those API:

  • GET ⇒ IEnumerable<DTO>
  • GET ⇒ DTO (searching by key)
  • POST ⇒ DTO
  • PUT ⇒ DTO
  • DELETE ⇒ DTO (using POST verb)

The api, and relative routes, will be created in this way:

  • MapGet ⇒ "/X" + typeof(�YourDto�).Name
  • MapGet ⇒ "/X" + typeof(�YourDto�).Name + "/{key}"
  • MapPost ⇒ "/X" + typeof(�YourDto�).Name , myDto
  • MapPut ⇒ "/X" + typeof(�YourDto�).Name , myDto
  • MapPost ⇒ "/XDelete" + typeof(�YourDto�).Name , myDto

NB: Navigation properties (FK) are automatically loaded.

To load also �collection� navigations you must explicitly declare it within the attribute:

[AddXMapEndpoints(includeChildren: true)]

Examples:

// Get a LIST of DTO

var many = await httpClient.GetFromJsonAsync<List<MyDto>>(baseUri + "X" + nameof(MyDto));

// Get a SINGLE DTO (with key = 1)

var one = await httpClient.GetFromJsonAsync<MyDto>(baseUri + "X" + nameof(MyDto) +"/1");

// Create a new entity (mapped from myDto)

var newDto = await httpClient.PostAsJsonAsync<MyDto>(baseUri + "X" + nameof(MyDto), myDto);

// Update an existing entity (mapped from myDto)

var updDto = await httpClient.PutAsJsonAsync<MyDto>(baseUri + "X" + nameof(MyDto), myDto);

// Delete an existing entity (mapped from myDto) NB: POST verb is used (to pass dto as body)

var res = await httpClient.PostAsJsonAsync<MyDto>(baseUri + "XDelete" + nameof(MyDto), myDto);

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.

Version Downloads Last updated
2.2.2 109 3/3/2024
2.1.0 90 3/3/2024
2.0.0 103 3/2/2024
1.1.0 75 2/23/2024
1.0.0 85 2/17/2024