csharpfritz / csharpfritz/InstantAPIs

Allow custom Dtos for endpoints

Aperta
#75 0 commenti 1 reazione 0 assegnatari Vedi su GitHub
Lingua principale
C#
Stelle
453
Fork
58
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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
});
`

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia dal punto di ingresso della configurazione di MapInstantAPIs e traccia il modo in cui i tipi di entità diventano modelli di richiesta degli endpoint. Confronta il flusso di inserimento richiesto di AddFoodDto/UseCustomDto con il body Swagger generato; il lavoro è completato quando un chiamante può fornire un DTO personalizzato per un endpoint e questo viene mappato sull'entità come richiesto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
csharp
Ambito
api, backend
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.