Выбор между API на основе контроллера и минимальными API

ASP.NET Core поддерживает два подхода к созданию API: подход на основе контроллера и минимальные API. Контроллеры в проекте API — это классы , производные от ControllerBase. Минимальные API определяют конечные точки с логическими обработчиками в лямбда-кодах или методах. В этой статье приводятся различия между двумя подходами.

Проектирование минимальных API скрывает класс узла по умолчанию и фокусируется на конфигурации и расширяемости с помощью методов расширения, которые принимают функции в качестве лямбда-выражений. Контроллеры — это классы, которые могут принимать зависимости с помощью внедрения конструктора или внедрения свойств, а также обычно следовать объектно-ориентированным шаблонам. Минимальные API поддерживают внедрение зависимостей с помощью других подходов, таких как доступ к поставщику услуг.

Ниже приведен пример кода для API на основе контроллеров:

namespace APIWithControllers;

public class Program
{
    public static void Main(string[] args)
    {
        var builder = WebApplication.CreateBuilder(args);

        builder.Services.AddControllers();
        var app = builder.Build();

        app.UseHttpsRedirection();

        app.MapControllers();

        app.Run();
    }
}

using Microsoft.AspNetCore.Mvc;

namespace APIWithControllers.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(Name = "GetWeatherForecast")]
    public IEnumerable<WeatherForecast> Get()
    {
        return Enumerable.Range(1, 5).Select(index => new WeatherForecast
        {
            Date = DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
            TemperatureC = Random.Shared.Next(-20, 55),
            Summary = Summaries[Random.Shared.Next(Summaries.Length)]
        })
        .ToArray();
    }
}

Следующий код предоставляет те же функции в минимальном проекте API. Обратите внимание, что минимальный подход к API включает в себя связанный код в лямбда-выражениях.

namespace MinimalAPI;

public class Program
{
    public static void Main(string[] args)
    {
        var builder = WebApplication.CreateBuilder(args);

        var app = builder.Build();

        app.UseHttpsRedirection();

        var summaries = new[]
        {
            "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
        };

        app.MapGet("/weatherforecast", (HttpContext httpContext) =>
        {
            var forecast = Enumerable.Range(1, 5).Select(index =>
                new WeatherForecast
                {
                    Date = DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
                    TemperatureC = Random.Shared.Next(-20, 55),
                    Summary = summaries[Random.Shared.Next(summaries.Length)]
                })
                .ToArray();
            return forecast;
        });

        app.Run();
    }
}

Оба проекта API относятся к следующему классу:

namespace APIWithControllers;

public class WeatherForecast
{
    public DateOnly Date { get; set; }

    public int TemperatureC { get; set; }

    public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);

    public string? Summary { get; set; }
}

Минимальные API имеют множество одинаковых возможностей, что и API на основе контроллера. Они поддерживают конфигурацию и настройку, необходимую для масштабирования до нескольких API, обработки сложных маршрутов, применения правил авторизации и управления содержимым ответов API. Существует несколько возможностей, доступных с помощью API на основе контроллера, которые еще не поддерживаются или реализуются минимальными API. Например:

• Встроенная поддержка привязки модели (IModelBinderProvider,). IModelBinder Эту поддержку можно добавить с помощью пользовательской оболочки привязки.
• Встроенная поддержка проверки (IModelValidator).
• Нет поддержки частей приложения или модели приложения. Невозможно применить или создать собственные соглашения.
• Нет встроенной поддержки отрисовки представления. Для отображения представлений мы рекомендуем использовать страницы Razor.
• Нет поддержки JsonPatch.
• Нет поддержки OData.

См. также

• Создание веб-API с помощью ASP.NET Core.
• Руководство по созданию веб-API с помощью ASP.NET Core
• Общие сведения о минимальных API
• Руководство. Создание минимального API с помощью ASP.NET Core