Swagger para .NET Core MVC Web API

Swagger (OpenAPI) é uma especificação independente de linguagem para descrever APIs REST. Ele permite que computadores e humanos entendam os recursos de uma API REST sem acesso direto ao código-fonte. Swagger UI oferece uma UI baseada na web que fornece informações sobre o serviço, usando a especificação OpenAPI gerada. Swagger UI é uma alternativa ao Postman.

Usei o Swagger várias vezes em meus artigos, mas apenas como uma ferramenta menor usada em diferentes tópicos. Quando tentei obter informações do Swagger, tive que pesquisar nesses artigos, que não eram convenientes. Então, reescrevo esses dois artigos, especialmente sobre Swagger para .NET MVC Web API ou .NET Core MVC Web API.

Introdução

Se tivéssemos criado um novo projeto de API Web .NET Core 5.0, o Swagger cient for Web API seria instalado por padrão. Em nosso caso atual, embora usemos o .NET Core 5.0, a API da Web é criada em um módulo MVC, portanto, precisamos instalar o Swagger manualmente. Dessa forma, funcionará para a versão .NET Core anterior à 5.0.

Este artigo é parte do meu outro artigo:  Consumir Web API por MVC No .NET Core (1), Server And Framework , temos aqui a parte relacionada ao Swagger. Você pode ver detalhes de lá.

Etapa 1 - Criar um aplicativo ASP.NET Core MVC

Usamos a versão do Visual Studio 2019 16.8 e .NET 5.0 SDK para compilar o aplicativo.

  1. Inicie o Visual Studio e selecione Criar um novo projeto.
  2. Na caixa de diálogo Criar um novo projeto, selecione Aplicativo Web ASP.NET Core > Avançar.
  3. Na caixa de diálogo Configurar seu novo projeto, insira  MVCCallWebAPI o nome do projeto.
  4. Selecione Criar.
  5. Na caixa de diálogo Criar um novo aplicativo Web ASP.NET Core, selecione,
    1. .NET Core e ASP.NET Core 5.0 nas listas suspensas.
    2. Aplicativo Web ASP.NET Core (Model-View-Controller).
    3. Crio

Compile e execute o aplicativo, você verá a imagem a seguir mostra o aplicativo,

Etapa 2~3 - Controlador de API do Scaffold com Ação usando o Entity Framework

Consulte o artigo  Consume Web API By MVC In .NET Core (1), Server And Framework ,

B: Adicione a API da Web com o código do Entity Framework primeiro

  • Etapa 1: configurar um novo contexto de banco de dados
  • Etapa 2: trabalhar com um banco de dados usando o primeiro aplicativo de código do Entity Framework.
  • Etapa 3,:Scaffold API Controller com Action usando Entity Framework

Etapa 4 - Adicionar cliente Swagger para API da Web

1. Instale o cliente Swagger

Clique com o botão direito do mouse no projeto em Solution Explorer > Manage NuGet Packages, procure  Swagger

Existem três componentes principais para o Swashbuckle (Swagger), precisamos apenas instalar dois deles: SwaggerGen e SwaggerUI, o Swagger seria incluído.

2. Registre o Swagger Client no   arquivo startup.cs

Adicione o gerador Swagger à coleção de serviços no  Startup.ConfigureServices método,

// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
    // Register the Swagger generator, defining 1 or more Swagger documents
    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v2", new OpenApiInfo { Title = "MVCCallWebAPI", Version = "v2" });
    });
    ......
}

Habilite o middleware para servir o documento JSON gerado e a UI Swagger, no  Startup.Configure método,

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // Enable middleware to serve generated Swagger as a JSON endpoint.
    app.UseSwagger();

    // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.),
    // specifying the Swagger JSON endpoint.
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v2/swagger.json", "MVCCallWebAPI");
    });
    ......
}

Agora, estamos quase prontos para executar o aplicativo.

Etapa 5 - Executar e testar o aplicativo

Antes de executarmos o aplicativo, modifique o cabeçalho do arquivo:  Views/Shared/_layout.cshtml  Views novamente para adicionar Swagger (linha 11~13), mostrado abaixo,

<header>
    <nav class="navbar navbar-expand-sm navbar-toggleable-sm navbar-light bg-white border-bottom box-shadow mb-3">
        <div class="container">
            <a class="navbar-brand" asp-area="" asp-controller="StoresMVC" asp-action="Index">MVC app</a>
            <button class="navbar-toggler" type="button" data-toggle="collapse" data-target=".navbar-collapse" aria-controls="navbarSupportedContent"
                    aria-expanded="false" aria-label="Toggle navigation">
                <span class="navbar-toggler-icon"></span>
            </button>
            <div class="navbar-collapse collapse d-sm-inline-flex justify-content-between">
                <ul class="navbar-nav flex-grow-1">
                    <li class="nav-item">
                        <a class="nav-link text-dark" asp-area="" asp-controller="Swagger" asp-action="Index">Web API</a>
                    </li>
                    <li class="nav-item">
                        <a class="nav-link text-dark" asp-area="" asp-controller="Home" asp-action="Index">Home</a>
                    </li>
                    <li class="nav-item">
                        <a class="nav-link text-dark" asp-area="" asp-controller="Home" asp-action="Privacy">Privacy</a>
                    </li>
                </ul>
            </div>
        </div>
    </nav>
</header>

Agora, executamos o aplicativo,

Clique em Web API, temos a tela do Swagger Client,

 

Fonte: https://www.c-sharpcorner.com/article/swagger-for-net-core-mvc-web-api/

#dotnet #netcore #mvc #webapi 

What is GEEK

Buddha Community

Swagger para .NET Core MVC Web API
Einar  Hintz

Einar Hintz

1602560783

jQuery Ajax CRUD in ASP.NET Core MVC with Modal Popup

In this article, we’ll discuss how to use jQuery Ajax for ASP.NET Core MVC CRUD Operations using Bootstrap Modal. With jQuery Ajax, we can make HTTP request to controller action methods without reloading the entire page, like a single page application.

To demonstrate CRUD operations – insert, update, delete and retrieve, the project will be dealing with details of a normal bank transaction. GitHub repository for this demo project : https://bit.ly/33KTJAu.

Sub-topics discussed :

  • Form design for insert and update operation.
  • Display forms in modal popup dialog.
  • Form post using jQuery Ajax.
  • Implement MVC CRUD operations with jQuery Ajax.
  • Loading spinner in .NET Core MVC.
  • Prevent direct access to MVC action method.

Create ASP.NET Core MVC Project

In Visual Studio 2019, Go to File > New > Project (Ctrl + Shift + N).

From new project window, Select Asp.Net Core Web Application_._

Image showing how to create ASP.NET Core Web API project in Visual Studio.

Once you provide the project name and location. Select Web Application(Model-View-Controller) and uncheck HTTPS Configuration. Above steps will create a brand new ASP.NET Core MVC project.

Showing project template selection for .NET Core MVC.

Setup a Database

Let’s create a database for this application using Entity Framework Core. For that we’ve to install corresponding NuGet Packages. Right click on project from solution explorer, select Manage NuGet Packages_,_ From browse tab, install following 3 packages.

Showing list of NuGet Packages for Entity Framework Core

Now let’s define DB model class file – /Models/TransactionModel.cs.

public class TransactionModel
{
    [Key]
    public int TransactionId { get; set; }

    [Column(TypeName ="nvarchar(12)")]
    [DisplayName("Account Number")]
    [Required(ErrorMessage ="This Field is required.")]
    [MaxLength(12,ErrorMessage ="Maximum 12 characters only")]
    public string AccountNumber { get; set; }

    [Column(TypeName ="nvarchar(100)")]
    [DisplayName("Beneficiary Name")]
    [Required(ErrorMessage = "This Field is required.")]
    public string BeneficiaryName { get; set; }

    [Column(TypeName ="nvarchar(100)")]
    [DisplayName("Bank Name")]
    [Required(ErrorMessage = "This Field is required.")]
    public string BankName { get; set; }

    [Column(TypeName ="nvarchar(11)")]
    [DisplayName("SWIFT Code")]
    [Required(ErrorMessage = "This Field is required.")]
    [MaxLength(11)]
    public string SWIFTCode { get; set; }

    [DisplayName("Amount")]
    [Required(ErrorMessage = "This Field is required.")]
    public int Amount { get; set; }

    [DisplayFormat(DataFormatString = "{0:MM/dd/yyyy}")]
    public DateTime Date { get; set; }
}

C#Copy

Here we’ve defined model properties for the transaction with proper validation. Now let’s define  DbContextclass for EF Core.

#asp.net core article #asp.net core #add loading spinner in asp.net core #asp.net core crud without reloading #asp.net core jquery ajax form #asp.net core modal dialog #asp.net core mvc crud using jquery ajax #asp.net core mvc with jquery and ajax #asp.net core popup window #bootstrap modal popup in asp.net core mvc. bootstrap modal popup in asp.net core #delete and viewall in asp.net core #jquery ajax - insert #jquery ajax form post #modal popup dialog in asp.net core #no direct access action method #update #validation in modal popup

Andre  Fisher

Andre Fisher

1626394980

Securing Web API using JWT|WEB API CRUD|Use Swagger|Use Token in .NET Core MVC Application

Creating a JWT Authentication Web API. How to use Token in ASP.NET Core MVC Application.
✔ Test API using SWAGGER & Postman.
✔ How to pass Bearer Token using Swagger.
✔ Complete Web API CRUD.
✔ Call Web API from ASP.NET Core MVC Controller.
✔ Keep token in Session.

✅ Download Source Code: https://payhip.com/b/2XfI

0:00 | Create Web API CRUD Using EF Core
8:23 | How to use Swagger
14:01 | How to use JWT
30:54 | Pass Bearer token using Swagger
32:53 | Test API using Postman
34:27 | Login Demo, Calling API from MVC Controller & use Token

👉FOLLOW US:
On Facebook: https://www.facebook.com/ashproghelp
On Blog: http://ashproghelp.blogspot.com

👉ASP.NET Core Tutorial Playlist:

https://www.youtube.com/playlist?list=PLprnOV9ZLFnscrKZoHtAJvl1hsP_rpyIH

👉ASP.NET Core WEB API Playlist:

https://www.youtube.com/playlist?list=PLprnOV9ZLFnsR9fB624xD8uk0tIOyByl4

👉Blazor Tutorial Playlist:

https://www.youtube.com/playlist?list=PLprnOV9ZLFnt_W3qsBAgxvwgQ4NBNJmvx

👉ASP.NET Core Authentication Playlist:

https://www.youtube.com/playlist?list=PLprnOV9ZLFnv0ZYY0bJT2LMukEN634fiD

👉SignalR Tutorials Playlist:

https://www.youtube.com/playlist?list=PLprnOV9ZLFnuKYOOXw_NE9RM5UcPmM-yp

👉KENDO UI Tutorials (WEB DEVELOPMENT) Playlist:

https://www.youtube.com/playlist?list=PLprnOV9ZLFns32TRnvTr7FgrPQH8kMog6

👉KENDO UI in ASP.NET Core Playlist:

https://www.youtube.com/playlist?list=PLprnOV9ZLFnsoYCrjDuNmWxmWm5WRBXY1

👉Files or Image Upload Playlist:

https://www.youtube.com/playlist?list=PLprnOV9ZLFnsFxlwKs-tOs13kqpakWI9e

👉==========AMCHARTS GRAPH JQUERY PLAYLIST==========
https://www.youtube.com/playlist?list=PLprnOV9ZLFnsGDKm_5W__HErKwGl3H1wu

👉=================RDLC Report PlayList===============
https://www.youtube.com/playlist?list=PLprnOV9ZLFnswiKegU95eTyu7nc_YSZmT

👉=================RDLC PRINT===============
How to print without showing report viewer in RDLC report - C#
https://www.youtube.com/watch?v=uTzwk6zBdQs

👉=================RDLC & Crystal Report===============
https://www.youtube.com/playlist?list=PLprnOV9ZLFnsTnvqGApmsCJqdOi15MVdE

👉=================SQL Server Tutorials (Series)===============
https://www.youtube.com/playlist?list=PLprnOV9ZLFntdSaPFBcMMc89XnH8gfRNy

👉=========TEAM FOUNDATION SERVER=============
TFS source control for beginners:
https://www.youtube.com/watch?v=AjhNxCUTEio

👉==========ANDROID APP DEVELOPMENT============
Quick Learn Android full basic in 45 minutes:
https://www.youtube.com/playlist?list=PLprnOV9ZLFntpdZb7cMvpHGE4YBzPDZJY

👉=================C# Basic=============================
https://www.youtube.com/playlist?list=PLprnOV9ZLFnvpVNZT6WFJeUAuVBNny9Pp

#JWTAuthentication #WebAPICrud #Swagger #UseJWTToken

#web api #jwt #web api #swagger #.net core mvc #.net core

Einar  Hintz

Einar Hintz

1602564619

MVC User Registration & Login with ASP.NET Core Identity

User registration and authentication are mandatory in any application when you have little concern about privacy. Hence all most all application development starts with an authentication module. In this article, we will discuss the quickest way to use **ASP.NET Core Identity for User Login and Registration **in a new or existing MVC application.

Sub-topics discussed :

  • How to add ASP.NET Core Identity to MVC application.
  • Customize ASP.NET Core Identity.
  • Identity.UI Design Customization.
  • Next step.

Background

ASP.NET Core Identity is an API, which provides both user interface(UI) and functions for user authentication, registration, authorization, etc. Modules/ APIs like this will really be helpful and fasten the development process. It comes with ASP.NET Core Framework and used in many applications before. Which makes the API more dependable and trustworthy.

ASP.NET Core MVC with user authentication can easily be accomplished using Identity.UI. While creating the MVC project, you just need to select Authentication as Individual User Accounts.

Showing how to create an MVC application with ASP.NET Core Identity API

The rest will be handled by ASP.NET Core Identity UI. It already contains razor view pages and backend codes for an authentication system. But that’s not what we want in most of the cases. we want to customize ASP.NET Core Identity as per our requirement. That’s what we do here.

Create an ASP.NET Core MVC Project

First of all, I will create a brand new ASP.NET Core MVC application without any authentication selected. We could add ASP.NET Core Identity later into the project.

In Visual Studio 2019, Go to File > New > Project (Ctrl + Shift + N). From new project window, select ASP.NET Core Web Application.

Create an ASP.NET Core Web application

Once you provide the project name and location. A new window will be opened as follows, Select _Web Application(Model-View-Controller), _uncheck _HTTPS Configuration _and DO NOT select any authentication method. Above steps will create a brand new ASP.NET Core MVC project.

Select Model View Controller templet under .NET Core

#asp.net core article #asp.net core #add asp.net core identity to existing project #asp.net core identity in mvc #asp.net core mvc login and registration #login and logout in asp.net core

Deion  Hilpert

Deion Hilpert

1594194798

Swagger Web API Versioning with Group By | ASP.NET Core Web API

Swagger Web API Version. Swagger Web API Versioning. Swashbuckle API Version. Swagger ASP.NET Core WEB API Versioning Example. API Version using Swagger. API Version Swagger ASP.NET Core. Swashbuckle WEB API Versioning.

#asp.net #.net core #asp.net core #api #swagger

Coty  Padberg

Coty Padberg

1592463853

Step by Step Tutorial - .Net Core MVC REST API

A full step by step tutorial on how to create a .Net Core MVC REST API completely from scratch. We additionally use Entity Framework Core with Microsoft SQL …

#.net core mvc rest api #.net core mvc #api #.net #programming