Úvod
Dokumentování softwaru, který vytváříte, má mnoho výhod. Důkladná dokumentace usnadňuje pozdější údržbu kódu a také zlepšuje jeho použitelnost pro další uživatele. Lepší použitelnost kódu je zvlášť důležitá, pokud chcete své rozhraní API zpřístupnit dalším lidem. Naštěstí existují nástroje a architektura, které snižují náklady na vytváření kvalitní dokumentace.
Předpokládejme, že jste vedoucí vývojář v rámařské firmě. Vaše společnost se rozhodla veřejně zpřístupnit svá rozhraní API. Mnoho z těchto rozhraní API nemá žádnou dokumentaci a je vaší zodpovědností je zdokumentovat. Dokumentace rozhraní API usnadňuje vašim partnerům jejich správné používání, což vede k nižším nákladům na podporu a údržbu.
Potřebujete snadný a standardizovaný způsob dokumentování jednotlivých rozhraní API. Potřebujete také metodu hostování dokumentace v umístění, které je pro partnery přístupné.
V tomto modulu se naučíte dokumentovat existující rozhraní API ASP.NET Core pomocí Swashbuckle, Swaggeru, Swagger UI a OpenAPI.
Cíle výuky
V tomto modulu:
- Seznamte se s uživatelským rozhraním Swashbuckle, OpenAPI a Swagger.
- Povolte OpenAPI pro rozhraní API C#/ASP.NET Core.
- Použijte Swashbuckle v rozhraní API C#/ASP.NET Core.
- Generování a zobrazení dokumentace k rozhraní API pomocí OpenAPI
Požadavky
- Zkušenost s návrhem a implementací REST API
- Zkušenost s vývojem základních aplikací v ASP.NET Core
- Místní instalace sady .NET SDK, Visual Studio Code a rozšíření jazyka C# pro Visual Studio Code