Lekce 11 - ASP.NET Web API - Testování a dokumentace pomocí Swagger
V minulé lekci, ASP.NET Web API - Stránkování a práce s parametry URL adresy, jsme si naše API rozšířili o koncové body vracející buď herce, nebo režiséry a představili si princip stránkování.
V dnešním ASP.NET Web API tutoriálu, v jazyce C# .NET, se naučíme automaticky generovat dokumentaci podle specifikace OpenAPI, kterou si nakonec zobrazíme pomocí nástroje SwaggerUI jako webovou stránku.
Začneme však tím, že si o specifikaci OpenAPI něco málo řekneme. OpenAPI je specifikace, která nám nabízí jednotný, jednoduchý a strojově čitelný formát pro dokumentaci (popis) RESTful webových API. Lidem i počítačům tak umožňuje snadno porozumět možnostem API bez přímého přístupu ke zdrojovému kódu. Tato specifikace je nezávislá na konkrétním jazyce, ve kterém je API napsáno. Používá se tedy jak pro API napsaná v ASP.NET, tak i pro API napsaná například ve Spring Boot, Node.js a mnohých dalších technologiích.
Specifikace OpenAPI byla dříve známa pod názvem Swagger. Tato specifikace se však v minulosti stala součástí iniciativy OpenAPI, a tak se přejmenovala. Proto bychom v případě, že odkazujeme jen na specifikaci, měli správně používat pojem OpenAPI. Pojmem Swagger pak odkazujeme na soubor nástrojů, které se specifikací OpenAPI pracují. Takovým nástrojem je například nástroj SwaggerUI pro generování webového rozhraní k prohlížení dokumentace vyhovující specifikaci OpenAPI. Pojmy Swagger a OpenAPI se často používají zaměnitelně.
Swagger v .NET
Dvě hlavní implementace specifikace OpenAPI v .NET jsou:
...konec náhledu článku...
Pokračuj dál
Došel jsi až sem a to je super! Věříme, že ti první lekce ukázaly něco nového a užitečného.
Chceš v kurzu pokračovat? Přejdi do prémiové sekce.
Koupit tento kurz
Před koupí tohoto článku je třeba koupit předchozí díl
Obsah článku spadá pod licenci Premium III, koupí článku souhlasíš se smluvními podmínkami.
- Neomezený a trvalý přístup k jednotlivým lekcím.
- Kvalitní znalosti v oblasti IT.
- Dovednosti, které ti pomohou získat vysněnou a dobře placenou práci.
Popis článku
Požadovaný článek má následující obsah:
V ASP.NET Web API tutoriálu se naučíme automaticky generovat dokumentaci podle specifikace OpenAPI a zobrazíme si ji jako webovou stránku.
Kredity získáš, když podpoříš naši síť. To můžeš udělat buď zasláním symbolické částky na podporu provozu nebo přidáním obsahu na síť.
