Demo: API të qarta me ASP.NET Core

Kontrata para implementimit

Artikull demonstrues për pamjen e blogut. Shembujt janë ilustrues dhe nuk përshkruajnë një sistem prodhimi.

Një API e lexueshme fillon me hyrje dhe dalje të qarta. Emrat e fushave, statuset HTTP dhe rregullat e validimit duhet të jenë të kuptueshme për klientin.

Një përgjigje e thjeshtë

public sealed record ArticleSummary(
    string Title,
    string Slug,
    bool IsPublished);

var summary = new ArticleSummary(
    "Shembull demonstrues",
    "shembull-demonstrues",
    true);

Paraqitja JSON

{
  "title": "Shembull demonstrues",
  "slug": "shembull-demonstrues",
  "isPublished": true
}

Statuset HTTP

Statusi	Kuptimi	Përdorimi ilustrues
200	Kërkesa u përfundua	Leximi i një artikulli publik
404	Burimi nuk u gjet	Slug i panjohur ose artikull jo publik
503	Shërbimi nuk është në dispozicion	Varësi e përkohshme jashtë funksionit

Një mesazh gabimi duhet ta ndihmojë përdoruesin pa zbuluar detaje të brendshme.

Çfarë po testojmë

Ngjyrosjen e sintaksës për C# dhe JSON.
Tabelën në ekrane të ngushta.
Hapësirën mes paragrafëve dhe seksioneve.