From 7f9fe5493b037b444b738078251aa8d795c87da2 Mon Sep 17 00:00:00 2001 From: Maxwell Weru Date: Tue, 19 Mar 2024 15:05:15 +0300 Subject: [PATCH] Add warning on outdated docs for Tingle.AspNetCore.Swagger --- src/Tingle.AspNetCore.Swagger/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/Tingle.AspNetCore.Swagger/README.md b/src/Tingle.AspNetCore.Swagger/README.md index a4d46cb..4a877a6 100644 --- a/src/Tingle.AspNetCore.Swagger/README.md +++ b/src/Tingle.AspNetCore.Swagger/README.md @@ -1,5 +1,10 @@ # Tingle.AspNetCore.Swagger +> [!CAUTION] +> This documentation for `Tingle.AspNetCore.Swagger` may cover the mos recent version of the code. Use it sparingly +> +> See https://github.com/tinglesoftware/dotnet-extensions/issues/221 + Swagger is a specification for documenting your API and specifies the format (URL, method, and representation) used to describe REST web services. This library is used to generate API documentation as well as add API documentation UI through ReDoc. The library includes the `Swashbuckle.AspNetCore.SwaggerGen` library which is a Swagger generator that builds the `SwaggerDocument` objects directly from your routes, controllers, and models. It is combined with the Swagger endpoint middleware to automatically expose Swagger JSON.