{"id":13093,"date":"2023-03-19T01:21:12","date_gmt":"2023-03-19T01:21:12","guid":{"rendered":"https:\/\/mauricemuteti.info\/?p=13093"},"modified":"2023-03-19T01:21:12","modified_gmt":"2023-03-19T01:21:12","slug":"master-the-art-of-building-game-changing-apis-with-visual-studio-2019-and-swagger-dont-miss-out-on-these-pro-tips","status":"publish","type":"post","link":"https:\/\/mauricemuteti.info\/master-the-art-of-building-game-changing-apis-with-visual-studio-2019-and-swagger-dont-miss-out-on-these-pro-tips\/","title":{"rendered":"&#8220;Master the Art of Building Game-Changing APIs with Visual Studio 2019 and Swagger &#8211; Don&#8217;t Miss Out on These Pro Tips!&#8221;"},"content":{"rendered":"<div id=\"ez-toc-container\" class=\"ez-toc-v2_0_49 counter-hierarchy ez-toc-counter ez-toc-grey ez-toc-container-direction\">\n<div class=\"ez-toc-title-container\">\n<p class=\"ez-toc-title\">Table of Contents<\/p>\n<span class=\"ez-toc-title-toggle\"><a href=\"#\" class=\"ez-toc-pull-right ez-toc-btn ez-toc-btn-xs ez-toc-btn-default ez-toc-toggle\" aria-label=\"ez-toc-toggle-icon-1\"><label for=\"item-676de2b0dddaa\" aria-label=\"Table of Content\"><span style=\"display: flex;align-items: center;width: 35px;height: 30px;justify-content: center;direction:ltr;\"><svg style=\"fill: #999;color:#999\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" class=\"list-377408\" width=\"20px\" height=\"20px\" viewBox=\"0 0 24 24\" fill=\"none\"><path d=\"M6 6H4v2h2V6zm14 0H8v2h12V6zM4 11h2v2H4v-2zm16 0H8v2h12v-2zM4 16h2v2H4v-2zm16 0H8v2h12v-2z\" fill=\"currentColor\"><\/path><\/svg><svg style=\"fill: #999;color:#999\" class=\"arrow-unsorted-368013\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"10px\" height=\"10px\" viewBox=\"0 0 24 24\" version=\"1.2\" baseProfile=\"tiny\"><path d=\"M18.2 9.3l-6.2-6.3-6.2 6.3c-.2.2-.3.4-.3.7s.1.5.3.7c.2.2.4.3.7.3h11c.3 0 .5-.1.7-.3.2-.2.3-.5.3-.7s-.1-.5-.3-.7zM5.8 14.7l6.2 6.3 6.2-6.3c.2-.2.3-.5.3-.7s-.1-.5-.3-.7c-.2-.2-.4-.3-.7-.3h-11c-.3 0-.5.1-.7.3-.2.2-.3.5-.3.7s.1.5.3.7z\"\/><\/svg><\/span><\/label><input  type=\"checkbox\" id=\"item-676de2b0dddaa\"><\/a><\/span><\/div>\n<nav><ul class='ez-toc-list ez-toc-list-level-1 ' ><li class='ez-toc-page-1 ez-toc-heading-level-1'><a class=\"ez-toc-link ez-toc-heading-1\" href=\"https:\/\/mauricemuteti.info\/master-the-art-of-building-game-changing-apis-with-visual-studio-2019-and-swagger-dont-miss-out-on-these-pro-tips\/#Swagger_A_Powerful_Tool_for_API_Development\" title=\"Swagger: A Powerful Tool for API Development\">Swagger: A Powerful Tool for API Development<\/a><ul class='ez-toc-list-level-2'><li class='ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-2\" href=\"https:\/\/mauricemuteti.info\/master-the-art-of-building-game-changing-apis-with-visual-studio-2019-and-swagger-dont-miss-out-on-these-pro-tips\/#What_is_Swagger\" title=\"What is Swagger?\">What is Swagger?<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-3\" href=\"https:\/\/mauricemuteti.info\/master-the-art-of-building-game-changing-apis-with-visual-studio-2019-and-swagger-dont-miss-out-on-these-pro-tips\/#How_to_Use_Swagger_in_Visual_Studio_2019\" title=\"How to Use Swagger in Visual Studio 2019\">How to Use Swagger in Visual Studio 2019<\/a><ul class='ez-toc-list-level-3'><li class='ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-4\" href=\"https:\/\/mauricemuteti.info\/master-the-art-of-building-game-changing-apis-with-visual-studio-2019-and-swagger-dont-miss-out-on-these-pro-tips\/#Step_1_Create_a_new_ASPNET_Core_Web_Application\" title=\"Step 1: Create a new ASP.NET Core Web Application\">Step 1: Create a new ASP.NET Core Web Application<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-5\" href=\"https:\/\/mauricemuteti.info\/master-the-art-of-building-game-changing-apis-with-visual-studio-2019-and-swagger-dont-miss-out-on-these-pro-tips\/#Step_2_Install_the_Required_NuGet_Packages\" title=\"Step 2: Install the Required NuGet Packages\">Step 2: Install the Required NuGet Packages<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-6\" href=\"https:\/\/mauricemuteti.info\/master-the-art-of-building-game-changing-apis-with-visual-studio-2019-and-swagger-dont-miss-out-on-these-pro-tips\/#Step_3_Configure_Swagger_in_the_Startup_Class\" title=\"Step 3: Configure Swagger in the Startup Class\">Step 3: Configure Swagger in the Startup Class<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-7\" href=\"https:\/\/mauricemuteti.info\/master-the-art-of-building-game-changing-apis-with-visual-studio-2019-and-swagger-dont-miss-out-on-these-pro-tips\/#Step_4_Define_APIs_Using_Swagger_Annotations\" title=\"Step 4: Define APIs Using Swagger Annotations\">Step 4: Define APIs Using Swagger Annotations<\/a><\/li><li class='ez-toc-page-1 ez-toc-heading-level-3'><a class=\"ez-toc-link ez-toc-heading-8\" href=\"https:\/\/mauricemuteti.info\/master-the-art-of-building-game-changing-apis-with-visual-studio-2019-and-swagger-dont-miss-out-on-these-pro-tips\/#Step_5_Build_and_Test_the_API_with_Swagger\" title=\"Step 5: Build and Test the API with Swagger\">Step 5: Build and Test the API with Swagger<\/a><\/li><\/ul><\/li><li class='ez-toc-page-1 ez-toc-heading-level-2'><a class=\"ez-toc-link ez-toc-heading-9\" href=\"https:\/\/mauricemuteti.info\/master-the-art-of-building-game-changing-apis-with-visual-studio-2019-and-swagger-dont-miss-out-on-these-pro-tips\/#Conclusion\" title=\"Conclusion\">Conclusion<\/a><\/li><\/ul><\/li><\/ul><\/nav><\/div>\n<h1><span class=\"ez-toc-section\" id=\"Swagger_A_Powerful_Tool_for_API_Development\"><\/span>Swagger: A Powerful Tool for API Development<span class=\"ez-toc-section-end\"><\/span><\/h1>\n<p>Swagger is a tool that software developers use to simplify the implementation of RESTful web services. This framework allows for creating and documenting APIs with ease. As a result, Swagger promotes consistency and simplicity in API design, and accelerates API development by eliminating the need to hand-code complex API specifications. This article will discuss how to use Swagger in Visual Studio 2019.<\/p>\n<h2><span class=\"ez-toc-section\" id=\"What_is_Swagger\"><\/span>What is Swagger?<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>Swagger is an open-source framework that greatly simplifies the process of designing, building, documenting, and consuming RESTful web services. Its straightforward approach defines the structures and data elements of an API with ease, allowing developers to easily discover and understand an API\u2019s capabilities. As a result, it&#8217;s simpler to integrate with other software components and easier to consume. <\/p>\n<h2><span class=\"ez-toc-section\" id=\"How_to_Use_Swagger_in_Visual_Studio_2019\"><\/span>How to Use Swagger in Visual Studio 2019<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<h3><span class=\"ez-toc-section\" id=\"Step_1_Create_a_new_ASPNET_Core_Web_Application\"><\/span>Step 1: Create a new ASP.NET Core Web Application<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>To start using Swagger in Visual Studio 2019, create a new ASP.NET Core Web Application project. Ensure that the target framework is set to .NET Core 3.1 or higher. Click the Web Application (Model-View-Controller) template, provide the project name, and click Create.<\/p>\n<h3><span class=\"ez-toc-section\" id=\"Step_2_Install_the_Required_NuGet_Packages\"><\/span>Step 2: Install the Required NuGet Packages<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>After creating a new project, navigate to the Solution Explorer, right-click on the project name and click Manage NuGet Packages. Search and install the following NuGet packages: Swashbuckle.AspNetCore and Swashbuckle.AspNetCore.SwaggerUI.<\/p>\n<h3><span class=\"ez-toc-section\" id=\"Step_3_Configure_Swagger_in_the_Startup_Class\"><\/span>Step 3: Configure Swagger in the Startup Class<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>In Startup.cs file, configure Swagger by adding the following lines of code in the ConfigureServices method:<\/p>\n<pre><code>services.AddSwaggerGen(c =>\n{\n    c.SwaggerDoc(\"v1\", new OpenApiInfo { Title = \"My API\", Version = \"v1\" });\n});\n\n<\/code><\/pre>\n<p>In the Configure method add the following lines of code:<\/p>\n<pre><code>app.UseSwagger();\napp.UseSwaggerUI(c => c.SwaggerEndpoint(\"\/swagger\/v1\/swagger.json\", \"My API v1\"));\n<\/code><\/pre>\n<p>The first line adds the Swagger middleware into the application pipeline, while the second line configures the Swagger UI to display API documentation.<\/p>\n<h3><span class=\"ez-toc-section\" id=\"Step_4_Define_APIs_Using_Swagger_Annotations\"><\/span>Step 4: Define APIs Using Swagger Annotations<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>To define APIs using Swagger annotations, add the following lines of code to the top of the WeatherForecastController.cs file:<\/p>\n<pre><code>using Microsoft.AspNetCore.Mvc;\nusing Microsoft.Extensions.Logging;\nusing System;\nusing System.Collections.Generic;\nusing System.Linq;\nusing System.Threading.Tasks;\nusing System.ComponentModel.DataAnnotations;\nusing Swashbuckle.AspNetCore.Annotations;\n<\/code><\/pre>\n<p>The method that you want to expose through API, add the following code:<\/p>\n<pre><code>[SwaggerOperation(\n    Summary = \"Gets the weather forecast for the next five days.\",\n    Description = \"Returns a list of weather forecast objects.\",\n    OperationId = \"GetWeatherForecast\",\n    Tags = new[] { \"Weather\" }\n)]\n[SwaggerResponse(200, \"OK\", typeof(IEnumerable&lt;WeatherForecast&gt;))]\n[HttpGet]\npublic IEnumerable&lt;WeatherForecast&gt; Get()\n{\n    var rng = new Random();\n    return Enumerable.Range(1, 5).Select(index =&gt; new WeatherForecast\n    {\n        Date = DateTime.Now.AddDays(index),\n        TemperatureC = rng.Next(-20, 55),\n        Summary = Summaries[rng.Next(Summaries.Length)]\n    })\n    .ToArray();\n}\n<\/code><\/pre>\n<p>The annotations added to the method provide details about its operations such as its summary, description, operation ID, and tags. Furthermore, it specifies the expected response code and data type.<\/p>\n<h3><span class=\"ez-toc-section\" id=\"Step_5_Build_and_Test_the_API_with_Swagger\"><\/span>Step 5: Build and Test the API with Swagger<span class=\"ez-toc-section-end\"><\/span><\/h3>\n<p>After setting up Swagger in Visual Studio 2019, press F5 to build and run the application. Open the Swagger UI in your web browser by heading to https:\/\/localhost:5001\/swagger\/index.html. <\/p>\n<p>To check your API&#8217;s details, click the GetWeatherForecast method under the Weather category. Then, the documentation appears, which shows the summary, description, operation ID, and response details that you specified. To test the API, click on the Try it out button and enter any required parameters. Click the Execute button to see the response. <\/p>\n<h2><span class=\"ez-toc-section\" id=\"Conclusion\"><\/span>Conclusion<span class=\"ez-toc-section-end\"><\/span><\/h2>\n<p>By following the above steps, it is easy to incorporate Swagger into your Visual Studio 2019 projects and simplify API development. With Swagger, you can ensure that your APIs are consistent, well-documented, and easy to consume. This way, developers can focus on building high-quality applications rather than complex API specifications. <\/p>\n","protected":false},"excerpt":{"rendered":"<p>Swagger: A Powerful Tool for API Development Swagger is a tool that software developers use to simplify the implementation of RESTful web services. This framework&hellip;<\/p>\n","protected":false},"author":1,"featured_media":12142,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[3297],"tags":[],"jetpack_featured_media_url":"https:\/\/mauricemuteti.info\/wp-content\/uploads\/2023\/03\/Visual-Studio-ULTIMATE-GUIDE-How-To-step-by-step-Tutorial.png","_links":{"self":[{"href":"https:\/\/mauricemuteti.info\/wp-json\/wp\/v2\/posts\/13093"}],"collection":[{"href":"https:\/\/mauricemuteti.info\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/mauricemuteti.info\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/mauricemuteti.info\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/mauricemuteti.info\/wp-json\/wp\/v2\/comments?post=13093"}],"version-history":[{"count":1,"href":"https:\/\/mauricemuteti.info\/wp-json\/wp\/v2\/posts\/13093\/revisions"}],"predecessor-version":[{"id":14033,"href":"https:\/\/mauricemuteti.info\/wp-json\/wp\/v2\/posts\/13093\/revisions\/14033"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/mauricemuteti.info\/wp-json\/wp\/v2\/media\/12142"}],"wp:attachment":[{"href":"https:\/\/mauricemuteti.info\/wp-json\/wp\/v2\/media?parent=13093"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/mauricemuteti.info\/wp-json\/wp\/v2\/categories?post=13093"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/mauricemuteti.info\/wp-json\/wp\/v2\/tags?post=13093"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}