11. diel - ASP.NET Web API - Testovanie a dokumentácia pomocou Swagger
V minulej lekcii, ASP.NET Web API - Stránkovanie a práca s parametrami URL adresy , sme si naše API rozšírili o koncové body vracajúce buď hercov, alebo režisérov a predstavili si princíp stránkovania.
V dnešnom ASP.NET Web API tutoriále, v jazyku C# .NET, sa naučíme automaticky generovať dokumentáciu podľa špecifikácie OpenAPI, ktorú si nakoniec zobrazíme pomocou nástroja SwaggerUI ako webovú stránku.
Začneme však tým, že si o špecifikácii OpenAPI niečo málo povieme. OpenAPI je špecifikácia, ktorá nám ponúka jednotný, jednoduchý a strojovo čitateľný formát pre dokumentáciu (opis) RESTful webových API. Ľuďom aj počítačom tak umožňuje ľahko porozumieť možnostiam API bez priameho prístupu k zdrojovému kódu. Táto špecifikácia je nezávislá na konkrétnom jazyku, v ktorom je API napísané. Používa sa teda ako pre API napísané v ASP.NET, tak aj pre API napísané napríklad v Spring Boot, Node.js a mnohých ďalších technológiách.
Špecifikácia OpenAPI bola predtým známa pod názvom Swagger. Táto špecifikácia sa však v minulosti stala súčasťou iniciatívy OpenAPI, a tak sa premenovala. Preto by sme v prípade, že odkazujeme len na špecifikáciu, mali správne používať pojem OpenAPI. Pojmom Swagger potom odkazujeme na súbor nástrojov, ktoré so špecifikáciou OpenAPI pracujú. Takýmto nástrojom je napríklad nástroj SwaggerUI na generovanie webového rozhrania na prezeranie dokumentácie vyhovujúcej špecifikácii OpenAPI. Pojmy Swagger a OpenAPI sa často používajú zameniteľne.
Swagger v .NET
Dve hlavné implementácie špecifikácie OpenAPI v .NET sú:
...koniec náhľadu článku...
Pokračuj ďalej
Minul si až sem a to je super! Veríme, že ti prvé lekcie ukázali niečo nového a užitočného.
Chceš v kurze pokračovať? Prejdi do prémiové sekcie.
Kúpiť tento kurz
Pred kúpou tohto článku je potrebné kúpiť predchádzajúci diel
Obsah článku spadá pod licenciu Premium III, kúpou článku súhlasíš so zmluvnými podmienkami.
- Neobmedzený a trvalý prístup k jednotlivým lekciím.
- Kvalitné znalosti v oblasti IT.
- Zručnosti, ktoré ti pomôžu získať vysnívanú a dobre platenú prácu.
Popis článku
Požadovaný článok má nasledujúci obsah:
V ASP.NET Web API tutoriálu sa naučíme automaticky generovať dokumentáciu podľa špecifikácie OpenAPI a zobrazíme si ju ako webovú stránku.
Kredity získaš, keď podporíš našu sieť. To môžeš urobiť buď zaslaním symbolickej sumy na podporu prevádzky alebo pridaním obsahu na sieť.
