Skip to content

Latest commit

 

History

History
463 lines (371 loc) · 10.6 KB

aspnetcorerest.md

File metadata and controls

463 lines (371 loc) · 10.6 KB
Raw

Kiinduló projekt

NuGet csomagok

  • Microsoft.EntityFrameworkCore.Tools
  • Microsoft.VisualStudio.Web.CodeGeneration.Design
  • Hellang.Middleware.ProblemDetails3
  • NSwag.AspNetCore

REST konvenciók

AddDbContext

builder.Services.AddDbContext<AppDbContext>(o =>
    o.UseSqlServer(builder.Configuration.GetConnectionString("DefaultConnection")));

DbContext ctor

public AppDbContext(DbContextOptions<AppDbContext> options)
    : base(options) {}

appsettings.Development.json

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Information",
    }
  },
  "ConnectionStrings": {
     "DefaultConnection": "<connection string>"
  }
}

Scaffold parancs

dotnet tool install -g dotnet-aspnet-codegenerator

cd .\WebApiLab.Api

dotnet aspnet-codegenerator controller -m WebApiLab.Dal.Entities.Product -dc WebApiLab.Dal.AppDbContext -outDir Controllers -name EFProductController -namespace WebApiLab.Api.Controllers -api

IDesignTimeDbContextFactory, ha nem működne a scaffolding

Néha előforduló hiba, hogy nem működik a scaffolding. Erre egy megoldás, hogy felveszünk IDesignTimeDbContextFactory<TContext> interfészt megvalósító osztályrat. Ezt vegyünk fel AppDbContextDesignTimeFactory néven a DAL projektbe, az implementációban csak vissza kell adnunk egy DbContext példányt. Conn stringnek elég ha valamilyen dummy értéket felveszünk. Viszont ezután a migrációk esetében a conn stringet paraméterként át kell adnink a CLI parancsnak.

public class AppDbContextFactory : IDesignTimeDbContextFactory<AppDbContext>
{
    public AppDbContext CreateDbContext(string[] args)
    {
        var builder = new DbContextOptionsBuilder<AppDbContext>();
        builder.UseSqlServer("dummy");
        return new AppDbContext(builder.Options);
    }
}

ProductService v1

public class ProductService : IProductService
{
    private readonly AppDbContext _context;

    public ProductService(AppDbContext context)
    {
        _context = context;
    }       

    public IEnumerable<Product> GetProducts()
    {
        var products = _context.Products
            .Include(p => p.Category)
            .Include(p => p.ProductOrders)
                .ThenInclude(po => po.Order)
            .ToList();

        return products;
    }
    /*Többi függvény generált implementációja*/
}

AutoMapper profil

using AutoMapper;

namespace WebApiLab.Bll.Dtos;

public class WebApiProfile : Profile
{
    public WebApiProfile()
    {
        CreateMap<Dal.Entities.Product, Product>().ReverseMap();
        CreateMap<Dal.Entities.Order, Order>().ReverseMap();
        CreateMap<Dal.Entities.Category, Category>().ReverseMap();
    }
}

ProductService w mapping

public IEnumerable<Product> GetProducts()
{
    var products = _context.Products
        .ProjectTo<Product>(_mapper.ConfigurationProvider)
        .AsEnumerable();
    return products;
}
public Product GetProduct(int productId)
{
    return _context.Products
        .ProjectTo<Product>(_mapper.ConfigurationProvider)
        .SingleOrDefault(p => p.Id == productId)
        ?? throw new EntityNotFoundException("Nem található a termék");
}
public Product InsertProduct(Product newProduct)
{
    var efProduct = _mapper.Map<Dal.Entities.Product>(newProduct);
    _context.Products.Add(efProduct);
    _context.SaveChanges();
    return GetProduct(efProduct.Id);
}
public void UpdateProduct(int productId, Product updatedProduct)
{
    var efProduct = _mapper.Map<Dal.Entities.Product>(updatedProduct);
    efProduct.Id = productId;
    _context.Entry(efProduct).State = EntityState.Modified;
    _context.SaveChanges();
}
public void DeleteProduct(int productId)
{
    _context.Products.Remove(new Dal.Entities.Product(null!) { Id = productId });
    _context.SaveChanges();
}

Product Post

Header

Content-Type: application/json

Body

{
    "Name" : "Pálinka",
    "UnitPrice" : 4000,
    "ShipmentRegion" : 1,
    "CategoryId" : 1
}

ProblemDetails in catch

ProblemDetails details= new ProblemDetails
{
    Title = "Invalid ID",
    Status = StatusCodes.Status404NotFound,
    Detail = $"No product with ID {id}"
};
return NotFound(details); //ProblemDetails átadása

ProblemDetails by MW

builder.Services.AddProblemDetails(options =>
{
    options.IncludeExceptionDetails = (ctx,ex) => false;
    options.MapToStatusCode<EntityNotFoundException>(StatusCodes.Status404NotFound);
});

UpdateProduct Exception => ProblemDetails

try
{
     _context.SaveChanges();
}
catch (DbUpdateConcurrencyException)
{
    if (_context.Products.SingleOrDefault(p => p.Id == productId) == null)
        throw new EntityNotFoundException("Nem található a termék");
    else
        throw;
}

DeleteProduct Exception => ProblemDetails

try
{
    _context.SaveChanges();
}
catch (DbUpdateConcurrencyException)
{
    if (_context.Products.SingleOrDefault(p => p.Id == productId) == null)
        throw new EntityNotFoundException("Nem található a termék");
    else
        throw;
}

Custom mapping Exception => ProblemDetails

services.AddProblemDetails(options =>
{
    options.IncludeExceptionDetails = (ctx, ex) => false;
    options.Map<EntityNotFoundException>(
        (ctx, ex) =>
        {
            var pd=StatusCodeProblemDetails.Create(StatusCodes.Status404NotFound);
            pd.Title = ex.Message;
            return pd;
        }
    );
});

Client - kiinduló

https://github.com/bmeaut/WebApiLab/tree/net6-client-init

NSwag

https://github.com/RicoSuter/NSwag/releases/latest

NET 6 client

Console.Write("ProductId: ");
var id = Console.ReadLine();
if(id != null)
    await GetProductAsync(int.Parse(id));

Console.ReadKey();

static async Task GetProductAsync(int id)
{
    using var client = new HttpClient();

    /*A portot írjuk át a szervernek megfelelően*/
    var response = await client.GetAsync(new Uri($"http://localhost:5184/api/Product/{id}"));
    response.EnsureSuccessStatusCode();
    var jsonStream = await response.Content.ReadAsStreamAsync();
    var json = await JsonDocument.ParseAsync(jsonStream);
    Console.WriteLine($"{json.RootElement.GetProperty("name")}:" +
        $"{json.RootElement.GetProperty("unitPrice")}.-");
}

GetProduct by id XML comment

/// <summary>
/// Get a specific product with the given identifier
/// </summary>
/// <param name="id">Product's identifier</param>
/// <returns>Returns a specific product with the given identifier</returns>
/// <response code="200">Listing successful</response>

PostProduct by id XML comment

/// <summary>
/// Creates a new product
/// </summary>
/// <param name="product">The product to create</param>
/// <returns>Returns the product inserted</returns>
/// <response code="201">Insert successful</response>

Enum as string

.AddJsonOptions(opts =>
{
    //opts.JsonSerializerOptions.ReferenceHandler = ReferenceHandler.Preserve;
    opts.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
});

NSwag Studio

https://github.com/RicoSuter/NSwag/releases

A zip változat-ot töltsük le és csomagoljuk ki. Ezután NSwagStudio.exe-vel indítható az alkalmazás.

GetProducts2Async

/**/if (id != null)
    {
        //await GetProductAsync(int.Parse(id));
        var p = await GetProduct2Async(int.Parse(id));
        Console.WriteLine($"{p.Name}: {p.UnitPrice}");
    }

static async Task<Product> GetProduct2Async(int id)
{
    using var httpClient = new HttpClient() 
        { BaseAddress = new Uri("http://localhost:5000/") };
    var client = new ProductClient(httpClient);
    return await client.GetAsync(id);
}

RowVersion model config

modelBuilder.Entity<Product>()
    .Property(p => p.RowVersion)
    .IsRowVersion();

Product.RowVersion migráció

Add-Migration ProductRowVersion
Update-Database

ConcurrencyProblemDetails

public record Conflict(object? CurrentValue, object? SentValue);

public class ConcurrencyProblemDetails : StatusCodeProblemDetails
{
    public Dictionary<string, Conflict> Conflicts { get; }

    public ConcurrencyProblemDetails(DbUpdateConcurrencyException ex) :
        base(StatusCodes.Status409Conflict)
    {
        Conflicts = new Dictionary<string, Conflict>();
        var entry = ex.Entries[0];
        var props = entry.Properties
            .Where(p => !p.Metadata.IsConcurrencyToken).ToArray();
        var currentValues = props.ToDictionary(
            p => p.Metadata.Name, p => p.CurrentValue);

        entry.Reload();

        foreach (var property in props)
        {
            if (!Equals(currentValues[property.Metadata.Name], property.CurrentValue))
            {
                Conflicts[property.Metadata.Name] = new Conflict
                (
                    property.CurrentValue,
                    currentValues[property.Metadata.Name]
                );
            }
        }
    }
}

DbUpdateConcurrencyException mapping

 options.Map<DbUpdateConcurrencyException>(
            ex => new ConcurrencyProblemDetails(ex));

Postman visualization - Test

var template = `
    <table bgcolor="#FFFFFF">
        <tr>
            <th>Name</th>
            <th>Unit price</th>
            <th>[Hidden]Concurrency token</th>
        </tr>

        {{#each response}}
            <tr>
                <td>{{name}}</td>
                <td>{{unitPrice}}</td>
                <td>{{rowVersion}}</td>
            </tr>
        {{/each}}
    </table>
`;
var respJson = pm.response.json();
pm.visualizer.set(template, {
    response: respJson
});

GetAllProds response save to variable - Test

pm.collectionVariables.set("u1_allprods",  JSON.stringify(respJson));

GetDetails - PRS

var allProds= JSON.parse(pm.collectionVariables.get("u1_allprods"));
var tejid=allProds.find(({ name }) => name.startsWith('Tej')).id;
pm.collectionVariables.set("u1_tejid",tejid);

GetDetails - Test

pm.collectionVariables.set("u1_tej",  pm.response.text());

Update - PRS

var tej= JSON.parse(pm.collectionVariables.get("u1_tej"));
tej.unitPrice++;
pm.collectionVariables.set("u1_tej_deluxe",JSON.stringify(tej));

Update for User2

tej.name='Tej ' +new Date().getTime();

Final postman collection

https://www.getpostman.com/collections/bf6157ad59c75b592f20