csharpfritz / csharpfritz/InstantAPIs

Allow custom Dtos for endpoints

Offen
#75 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
C#
Sterne
453
Forks
58
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

Suppose I have this class

`
public class Food : Record
{

public string Name { get; set; }
public decimal Portion { get; set; }
public decimal Calories { get; set; }
public decimal Carbohydrates { get; set; }
public decimal Lipids { get; set; }
public decimal Proteins { get; set; }
public decimal Fiber { get; set; }

public Guid SourceId { get; set; }
public Source Source { get; set; }

public Classification Classification { get; set; }
public NewClassification NewClassification { get; set; }

public ICollection FoodRecipes { get; set; }
}
`

When using InstantAPIs, the following swagger body model is created

`
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"registration": "2023-09-04T02:26:10.760Z",
"update": "2023-09-04T02:26:10.760Z",
"deletion": "2023-09-04T02:26:10.760Z",
"name": "string",
"portion": 0,
"calories": 0,
"carbohydrates": 0,
"lipids": 0,
"proteins": 0,
"fiber": 0,
"sourceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"source": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"registration": "2023-09-04T02:26:10.760Z",
"update": "2023-09-04T02:26:10.760Z",
"deletion": "2023-09-04T02:26:10.760Z",
"name": "string"
},
"classification": 0,
"newClassification": 0,
"foodRecipes": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"registration": "2023-09-04T02:26:10.760Z",
"update": "2023-09-04T02:26:10.760Z",
"deletion": "2023-09-04T02:26:10.760Z",
"recipeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"recipe": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"registration": "2023-09-04T02:26:10.760Z",
"update": "2023-09-04T02:26:10.760Z",
"deletion": "2023-09-04T02:26:10.760Z",
"name": "string",
"foodRecipes": [
"string"
]
},
"foodId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"food": "string"
}
]
}
`

I wish there would be a way to provide custom DTOs and maybe using AutoMapper to transforming to entity class, like

`
app.MapInstantAPIs(config =>
{
config.ExcludeTable(db => db.AnyTable);
config.UseCustomDto(db => db.Food, typeof(AddFoodDto), ApiMethodsToGenerate.Insert); // like this
});
`

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne am Konfigurationseinstiegspunkt von MapInstantAPIs und verfolge, wie Entitätstypen zu Endpoint-Request-Modellen werden. Vergleiche den angeforderten Insert-Flow von AddFoodDto/UseCustomDto mit dem generierten Swagger-Body; abgeschlossen ist die Aufgabe, wenn ein Aufrufer ein benutzerdefiniertes DTO für einen Endpoint bereitstellen kann und dieses wie angefordert auf die Entität abgebildet wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
api, backend
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.