Quack.Api 1.4.1

Quack API

Using the both Shadow Quack base library and Shadow Quack JSON this package includes custom implementation of JsonConverter and JsonConvertorFactory, that wrap the JSON proxy, to allow the use of Interfaces as return and parameter types in ASP .Net API calls.

by adding the QuackInterfaceConverterFactory to the Converters list,

services.AddControllers().AddJsonOptions(opts =>
    {
        opts.JsonSerializerOptions.Converters.Add(new QuackInterfaceConverterFactory());
    });

You can use interfaces as the inputs and outputs to your API calls without needing to do anything else!

WeatherForecastController.cs

using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Shadow.Quack;

namespace Example.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class WeatherForecastController : ControllerBase
    {
        private static readonly string[] Summaries = new[]
        {
            "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
        };

        private readonly ILogger<WeatherForecastController> _logger;

        public WeatherForecastController(ILogger<WeatherForecastController> logger)
        {
            _logger = logger;
        }

        [HttpGet]
        public IEnumerable<IWeatherForecast> Get()
        {
            var rng = new Random();
            return Enumerable.Range(1, 5).Select(index => Duck.Implement<IWeatherForecast>(new 
            {
                Date = DateTime.Now.AddDays(index),
                TemperatureC = rng.Next(-20, 55),
                Summary = Summaries[rng.Next(Summaries.Length)]
            }))
            .ToArray();
        }
    }
}

IWeatherForecast.cs

using System;

namespace Example
{
    public interface IWeatherForecast
    {
        DateTime Date { get; }
        int TemperatureC { get; }
        int TemperatureF { get; }
        string Summary { get; }
    }
}

The above shows using this with the Weather Forecast example API, note the Get() method now has only abstract interface types in the declaration; public IEnumerable<IWeatherForecast> Get() and the creation of the return value is done using Duck.Implement<T>(object source).

Interfaces can be used as the types for API inputs too, for example

[HttpPost]
public bool Post(IPostData data)
{
    return Process(data);
}

Options

Quack.Api.Options.Default returns a new JsonSerializerOptions instance with the QuackInterfaceConverterFactory already added.

JsonSerializerOptions .AddInterfaceConverters() extension which adds the QuackInterfaceConverterFactory to the converters, returns the JsonSerializerOptions instance for pipeline usage.