یک فریمورک HTTP سبک، برای ایجاد APIهای NET Core. است، در واقع یک wrapper بر روی APIهای موجود ASP.NET Core می‌باشد که به ما امکان ایجاد HTTP API را در کمترین زمان میدهد. در این مطلب نحوه ایجاد یک API را توسط این فریمورک بررسی خواهیم کرد.
برای شروع می‌توانیم قالب پروژه Feather HTTP را به لیست قالب‌های از پیش نصب شده‌ی dotnet اضافه کنیم. برای اینکار کافی است در خط فرمان دستور زیر را وارد کنیم:
همانطور که مشاهده می‌کنید پروژه‌ی فوق تنها شامل دو فایل .csproj و Program.cs است. درون Program.cs و متد Main کار initialize کردن سرور HTTP صورت گرفته است. WebApplication.Create دقیقا همانند Host.CreateDefaultBuilder پروژه‌های ASP.NET Core عمل می‌کند؛ یعنی پیکربندی pipeline از قبیل اضافه کردن متغیرهای محیطی، خواندن از فایل JSON و ... را انجام میدهد اما با کد boilerplate کمتر. بنابراین خروجی WebApplication.Create یک ASP.NET Core Pipeline با قابلیت اضافه کردن تنظیمات دلخواه است. در ادامه جهت بررسی بیشتر Feather HTTP، یک مدل را به همراه یک سری دیتای In-memory به پروژه اضافه خواهیم کرد:
using System.Collections.Generic;
using System.Text.Json.Serialization;
using System.Linq;
namespace todoAPI.Models
{
public class Todo
{
[JsonPropertyName("id")]
public int Id { get; set; }
[JsonPropertyName("title")]
public string Title { get; set; }
[JsonPropertyName("completed")]
public bool Completed { get; set; }
}
public class TodoData
{
private readonly IList<Todo> _db = new List<Todo>
{
new Todo { Id = 1, Title = "Read book" },
new Todo { Id = 2, Title = "Watch an episode of Dark" },
new Todo { Id = 3, Title = "Publish a post on dotnettips" },
new Todo { Id = 4, Title = "Skype with my friend" },
};
public IList<Todo> GetAllToDoItmes()
{
return _db;
}
public void AddTodo(Todo item)
{
_db.Add(item);
}
public void ToggleTodo(int id)
{
var todo = _db.FirstOrDefault(x => x.Id == id);
todo.Completed = !todo.Completed;
}
public void DeleteTodo(int id)
{
var todo = _db.FirstOrDefault(x => x.Id == id);
_db.Remove(todo);
}
}
} در مثال فوق برای نگاشت نام خواص، از System.Text.Json توکار NET Core 3.0. استفاده شده‌است. در ادامه نیز از یک کلاس برای شبیه‌سازی CRUD یک Todo استفاده شده‌است. سپس برای داشتن اندپوینت‌های موردنظر به ازای هر کدام از متدهای فوق درون متد Main، از app.Map... استفاده کرده‌ایم:
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using todoAPI.Models;
namespace todoAPI
{
class Program
{
private static readonly TodoData db = new TodoData();
static async Task Main(string[] args)
{
var app = WebApplication.Create(args);
app.MapGet("/", GetTodos);
app.MapPost("/api/todos", CreateTodo);
app.MapPost("/api/todos/{id}", ToggleTodo);
app.MapDelete("/api/todos/{id}", DeleteTodo);
await app.RunAsync();
}
static async Task GetTodos(HttpContext http)
{
var todos = db.GetAllToDoItmes();
await http.Response.WriteJsonAsync(todos);
}
static async Task CreateTodo(HttpContext http)
{
var todo = await http.Request.ReadJsonAsync<Todo>();
db.AddTodo(todo);
http.Response.StatusCode = 204;
}
static async Task ToggleTodo(HttpContext http)
{
if (!http.Request.RouteValues.TryGet("id", out int id))
{
http.Response.StatusCode = 400;
return;
}
db.ToggleTodo(id);
http.Response.StatusCode = 204;
}
static async Task DeleteTodo(HttpContext http)
{
if (!http.Request.RouteValues.TryGet("id", out int id))
{
http.Response.StatusCode = 400;
return;
}
db.DeleteTodo(id);
http.Response.StatusCode = 204;
}
}
}
هر کدام از اندپوینت‌های فوق، یک ورودی HttpContext دریافت خواهند کرد. توسط این شیء می‌توانیم به درخواست جاری و همچنین به پاسخ درخواست، دسترسی داشته باشیم.
استفاده از سیستم DI توکار NET Core.
همانطور که در ابتدای مطلب نیز عنوان شد، Feather HTTP یک wrapper بر روی APIهای موجود ASP.NET Core است، بنابراین می‌توانیم از همان سرویس DI که درون پروژه‌های ASP.NET Core در اختیار داریم در اینجا نیز استفاده کنیم. در ادامه یک پوشه‌ی جدید را به مثال قبل، با نام Controllers اضافه خواهیم کرد و درون آن یک فایل TodoController را با محتویات زیر ایجاد خواهیم کرد:
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using todoAPI.Models;
using todoAPI.Services;
namespace todoAPI.Controllers
{
public class TodoController
{
private readonly ITodoService _todoService;
public TodoController(ITodoService todoService)
{
_todoService = todoService;
}
public async Task GetTodos(HttpContext http)
{
var todos = _todoService.GetAllToDoItmes();
await http.Response.WriteJsonAsync(todos);
}
public async Task CreateTodo(HttpContext http)
{
var todo = await http.Request.ReadJsonAsync<Todo>();
_todoService.AddTodo(todo);
http.Response.StatusCode = 204;
}
public async Task ToggleTodo(HttpContext http)
{
if (!http.Request.RouteValues.TryGet("id", out int id))
{
http.Response.StatusCode = 400;
return;
}
_todoService.ToggleTodo(id);
http.Response.StatusCode = 204;
}
public async Task DeleteTodo(HttpContext http)
{
if (!http.Request.RouteValues.TryGet("id", out int id))
{
http.Response.StatusCode = 400;
return;
}
_todoService.DeleteTodo(id);
http.Response.StatusCode = 204;
}
}
}
کاری که انجام شده است، انتقال تمامی متدهای static به کلاس فوق و سپس جایگزین کردن کلمه‌ی کلیدی static با public است. همچنین یه ارجاع به اینترفیس جدید با عنوان ITodoService اضافه شده است؛ درون پیاده‌سازی این اینترفیس همان متدهای کلاس TodoData را اضافه کرده‌ایم:
using System.Collections.Generic;
using todoAPI.Models;
using System.Linq;
namespace todoAPI.Services
{
public interface ITodoService
{
void AddTodo(Todo item);
void DeleteTodo(int id);
IList<Todo> GetAllToDoItmes();
void ToggleTodo(int id);
}
public class TodoService : ITodoService
{
private readonly IList<Todo> _db = new List<Todo>
{
new Todo { Id = 1, Title = "Read book" },
new Todo { Id = 2, Title = "Watch an episode of Dark" },
new Todo { Id = 3, Title = "Publish a post on dotnettips" },
new Todo { Id = 4, Title = "Skype with my friend" },
};
public IList<Todo> GetAllToDoItmes()
{
return _db;
}
public void AddTodo(Todo item)
{
_db.Add(item);
}
public void ToggleTodo(int id)
{
var todo = _db.FirstOrDefault(x => x.Id == id);
todo.Completed = !todo.Completed;
}
public void DeleteTodo(int id)
{
var todo = _db.FirstOrDefault(x => x.Id == id);
_db.Remove(todo);
}
}
}
نکته: برای ایجاد اینترفیس از روی یک کلاس درون VS Code می‌توانیم اینگونه عمل کنیم:
تغییرات فایل Program.cs
ابتدا باید using مربوط به DI را در ابتدای فایل اضافه کنیم:
using Microsoft.Extensions.DependencyInjection;
سپس توسط ServiceProvider یک وهله از کلاس موردنظر را ایجاد کرده‌ایم و همچنین سرویس‌های موردنظر را درون DI Container اضافه کرده‌ایم:
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using todoAPI.Controllers;
using todoAPI.Services;
namespace todoAPI
{
class Program
{
static async Task Main(string[] args)
{
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddTransient<TodoController>();
builder.Services.AddTransient<ITodoService, TodoService>();
var serviceProvider = builder.Services.BuildServiceProvider();
var todoController = serviceProvider.GetService<TodoController>();
var app = WebApplication.Create(args);
app.MapGet("/", todoController.GetTodos);
app.MapPost("/api/todos", todoController.CreateTodo);
app.MapPost("/api/todos/{id}", todoController.ToggleTodo);
app.MapDelete("/api/todos/{id}", todoController.DeleteTodo);
await app.RunAsync();
}
}
}
Convention Over Configuration
در کد قبلی به صورت دستی TodoController را توسط Service Location از DI درخواست کرده‌ایم. اینکار را در ادامه می‌توانیم به Feather HTTP سپرده تا کار وهله‌سازی را براساس قواعد توکار برایمان انجام دهد:
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;
using todoAPI.Services;
namespace todoAPI
{
class Program
{
static async Task Main(string[] args)
{
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();
builder.Services.AddControllers();
builder.Services.AddSingleton<ITodoService, TodoService>();
var serviceProvider = builder.Services.BuildServiceProvider();
var app = builder.Build();
app.MapControllers();
await app.RunAsync();
}
}
}
سپس در ادامه برای دسترسی به HTTP Context درون TodoController از IHttpContextAccessor استفاده کرده‌ایم:
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using todoAPI.Models;
using todoAPI.Services;
namespace todoAPI.Controllers
{
public class TodoController
{
private readonly ITodoService _todoService;
private readonly IHttpContextAccessor _accessor;
public TodoController(ITodoService todoService, IHttpContextAccessor accessor)
{
_todoService = todoService;
_accessor = accessor;
}
[HttpGet("/todos")]
public async Task GetTodos()
{
var todos = _todoService.GetAllToDoItmes();
await _accessor.HttpContext.Response.WriteJsonAsync(todos);
}
[HttpPost("/todos")]
public async Task CreateTodo()
{
var todo = await _accessor.HttpContext.Request.ReadJsonAsync<Todo>();
_todoService.AddTodo(todo);
_accessor.HttpContext.Response.StatusCode = 204;
}
[HttpPost("/todos/{id}")]
public async Task ToggleTodo(int id)
{
_todoService.ToggleTodo(id);
_accessor.HttpContext.Response.StatusCode = 204;
}
[HttpDelete("/todos/{id}")]
public async Task DeleteTodo(int id)
{
_todoService.DeleteTodo(id);
_accessor.HttpContext.Response.StatusCode = 204;
}
}
}
کدهای کامل مطلب را میتوانید از اینجا دریافت کنید.
