Jorge Serrano
  • Home

Versionado de una ASP.NET Core 2 Web API sin usar Microsoft.AspNetCore.Mvc.Versioning

  • By jorge
  • Ene-23-2018
  • API REST, ASP.NET Core, Web API
  • 1 Comment.

Hay una forma básica, sencilla y rápida de versionar nuestra Web API desarrollada en ASP.NET Core 2, y es lo que voy a tratar de enseñaros a hacer en esta entrada.

Es más, también os mostraré mi forma de versionar las APIs. Es algo que quiero compartir por si os sirve, y que he utilizado en los últimos años en algunos proyectos en los que he trabajado para Microsoft y para otras empresas.

Cuando preguntamos cómo versionar nuestras Web API en ASP.NET Core 2, muchos desarrolladores tienden a decirnos que debemos utilizar el paquete NuGet Microsoft.AspNetCore.Mvc.Versioning.

Esto es cierto, pero no siempre es necesario llegar aquí para cubrir nuestras necesidades.

Me explico.

Según el contexto en el que nos encontremos, puede suceder que no tengamos necesidad de versionar nuestras Apis utilizando Microsoft.AspNetCore.Mvc.Versioning y hacerlo de la forma tradicional a como lo hacíamos en ASP.NET, o hacerlo de una forma más simple, sencilla y directa, sin añadir complejidad a nuestro proyecto.

Si queremos ir un poco más allá como tengo pensado mostrar en otras entradas, entonces sí es recomendable, quizás, versionar de otra manera. Y ahí sí, Microsoft.AspNetCore.Mvc.Versioning podría sernos de interés.

El caso es que aquí voy a mostraros la forma básica (y muchas veces suficiente) de hacerlo.

Manos a la obra…

En primer lugar, iniciaremos Visual Studio 2017 (en mi caso, tengo instalada la versión 15.5.3).

Para elegir una plantilla válida, elegiré la sección Web y dentro de esta sección la plantilla ASP.NET Core Web Application.
Indicaré un nombre para la ruta en la que quiero guardar mi proyecto.

A continuación indicaré que quiero crear un proyecto de tipo Web API con ASP.NET Core 2.0.
No habilitaré autenticación ni nada más.

A continuación, crearé una clase que pondré en el raiz y que se llamará ApiRoute.cs.
Luego iremos a ella.
Simplemente, créala y continuemos.

Dentro de la carpeta Controllers, eliminaremos cualquier controlador que encontremos allí para dejar todo lo más limpio posible.

Una vez hecho esto, me iré al árbol de proyectos y crearé una carpeta V1 dentro de la carpeta Controllers y crearé un nuevo controlador.
Para ello, haré clic con el botón derecho del ratón sobre la carpeta V1 que he creado dentro de la carpeta Controllers y elegiré la opción Add => Controller.
Aparecerá una ventana en la que seleccionaré la opción de crear un controlador vacío.

Nos aparecerá ahora una ventana más pequeña en la que tendremos que indicar el nombre del controlador (reservando, según la convención, la palabra reservada Controller siempre al final del nombre del controlador).
En mi caso, he llamado mi controlador como FooController.

Si acudimos a la ventana del explorador de soluciones, veremos que la estructura de nuestro proyecto tendrá un aspecto similar al siguiente:

Llegados a este punto, tenemos la estructura base de nuestra Web API, pero todavía no hemos creado ninguna ruta ni nada por el estilo, y respecto al versionado, únicamente hemos creado una carpeta V1 dentro de Controllers, y hemos creado dentro un controlador nuevo.

Bien, ahora pensemos como queremos servir nuestra Web API.
En concreto, pensemos en la estructura general de llamada.

Imaginemos que tenemos pensado hacer tres métodos Get.

  • Uno de ellos el general http://[server]/api/v1/foo.
  • Otro que nos dé todo el contenido http://[server]/api/v1/foo/all.
  • Y un tercer y último método al que pasemos un parámetro de entrada (un valor numérico por ejemplo) de forma que sea algo así como http://[server]/api/v1/foo/{id}.

Parece obvio, que la llamada general es compartida.
Es decir, la parte que se repite siempre es:

http://[server]/api/v1/foo

Bien, llevando este patrón hacia nuestra Web API, indicaré a continuación cómo lo hago yo (cada uno puede tener «su» forma de hacerlo, pero a mí esta forma me ha funcionado y el mantenimiento siempre me ha resultado muy sencillo).

Abriremos la clase ApiRoute y escribiremos el siguiente contenido:

public class ApiRoute
{

    /// <summary>
    /// <para>api/v1</para>
    /// </summary>
    private const string ApiVersionRoute = "api/v1";

    /// <summary>
    /// <para>api/v1/[controller]</para>
    /// </summary>
    public const string ControllerRoute = ApiVersionRoute + "/[controller]";

}

A continuación abriremos nuestro controlador y escribiremos este otro contenido:

public class FooController : Controller
{

    [HttpGet]
    [Route(ApiRoute.ControllerRoute)]
    public async Task<IActionResult> GetAsync() => Content(await GetDateTime() + " GetAsync");

    [HttpGet]
    [Route(ApiRoute.ControllerRoute + "/all")]
    public async Task<IActionResult> GetAllAsync() => Content(await GetDateTime() + " GetAllAsync");

    [HttpGet]
    [Route(ApiRoute.ControllerRoute + "/{id:int}")]
    public async Task<IActionResult> GetByIdAsync(int id) => Content(await GetDateTime() + $" and {id} GetByIdAsync");


    private async Task<string> GetDateTime()
    {
        return await Task.FromResult<string>(DateTime.UtcNow.ToString());
    }

}

Si ejecutamos nuestra Web API y la probamos con Fiddler u otro mecanismo que nos posibilite probar nuestra Web API, observaremos que se comporta tal y como queríamos.

De esta forma, tenemos nuestra Web API versionada, de forma rápida y sencilla.
Sin complicaciones.

Y en muchos proyectos nos resultará más que suficiente.

El mantenimiento sobre ApiRoute se hace de forma más sencilla que teniendo que ir a cada controlador y modificar cada método del controlador. Igual ocurre si queremos pasar de una V1 a una V2 o mantener una versión y crear otra nueva.

Si queremos hacer algún añadido, cambio, etc. un poco más rebuscado, igual tenemos que modificar ApiRoute, o bien tenemos que «fabricarnos» o ir a algo ya existente como podría ser Microsoft.AspNetCore.Mvc.Versioning.

El código fuente de esta implementación base de versionado, la encontrarás en este enlace de mi repositorio en GitHub.

¡Happy Coding!

Comments

One Responseso far

  1. Juan Martin dice:
    3 septiembre, 2020 a las 10:50 am

    Hola Jorge, no me queda claro como hacer para tener un controlador von v1 y el mismo con v2

    Responder

Deja un comentario Cancelar respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

← Previous Post Next Post →

Jorge Serrano

MVP Reconnect


¡Subscríbete a mi canal!
YouTube

Donaciones
Donation

Entradas recientes

  • Go – Arrays
  • Go – Operators
  • Go – Constants
  • Go – Tipos de Datos
  • Go – Variables
  • Hello Go-rld!
  • Introducción a Go o Golang
  • JSON Patch en ASP.NET Core 5 Web API
  • Null Checking en C#
  • ¿Porqué mi página web por defecto de ASP.NET Core no se vé en mi Azure Web App y me da un 404?

Categorías

  • .NET 5
  • .NET Core
  • .NET Core 3.0
  • .NET Core 3.1
  • .NET Framework 2.0
  • .NET Framework 3.0
  • .NET Framework 3.5
  • .NET Framework 4.0
  • .NET Framework 4.5
  • .NET Framework 4.6
  • .NET Framework 4.7
  • .NET Framework 4.8
  • .NET Standard 2.0
  • .NET Standard 2.1
  • AMQP
  • Android
  • Angular
  • API REST
  • Apple
  • Apple iOS
  • Apple macOs
  • Arquitectura
  • ASP.NET
  • ASP.NET Core
  • ASP.NET Core 3
  • ASP.NET Core 5
  • AWS
  • Azure App Service
  • Azure Application Insights
  • Azure Cosmos DB
  • Azure Database Migration Service
  • Azure Databricks
  • Azure DevOps
  • Azure Event Grid
  • Azure Functions
  • Azure IoT
  • Azure Portal
  • Azure PowerShell
  • Azure Queue Storage
  • Azure SQL
  • Azure Storage
  • Azure Virtual Datacenter
  • Azure WebApps
  • Big Data
  • Bing
  • Blazor
  • Blog
  • Bots
  • C#
  • C# 7.0
  • C# 7.1
  • C# 7.2
  • C# 7.3
  • C# 8.0
  • C# 9.0
  • Channel 9
  • Codeplex
  • Codespaces
  • Containers
  • Debugging
  • DevOps
  • Docker
  • Electron
  • Entity Framework
  • Entity Framework Core
  • Entity Framework Core 3.0
  • Entity Framework Core 5
  • Eventos
  • F#
  • FaaS
  • FeatureFlags
  • FeatureToggles
  • Feeds
  • Fluent Assertions
  • General
  • GIMP
  • Git
  • GitHub
  • Go
  • Google
  • Google Analytics
  • Gradle
  • gRPC
  • GSA
  • Historia de la Informática
  • HoloLens
  • HtmlAgilityPack
  • IdentityServer4
  • Inkscape
  • Ionic
  • iOS
  • IoT
  • Java
  • JavaScript
  • JDBC
  • JSON
  • Kubernetes
  • Lenguajes de Programación
  • Libros y Cursos
  • LINQ
  • Linux
  • LiteDB
  • Machine Learning
  • macOS
  • Microservices
  • Microsoft
  • Microsoft .NET Framework 4.5
  • Microsoft 365
  • Microsoft Azure
  • Microsoft Build
  • Microsoft Ignite
  • Microsoft Learn
  • Microsoft Orleans
  • Microsoft Surface Go
  • Microsoft Teams
  • ML.NET
  • MQTT
  • MRO
  • MS-DOS
  • MsCoders Madrid
  • MVP
  • NancyFx
  • Node.js
  • NoSQL
  • NuGet
  • NUnit
  • OData
  • ODP.NET Core
  • Office 2007
  • Office 2010
  • Office 2013
  • Office 2016
  • Office 2019
  • Office 365
  • Open Source
  • Open XML SDK
  • Opinión
  • Orchard CMS
  • OT
  • PaaS
  • Patterns
  • PdfSharpCore
  • Performance
  • PHP
  • Postman
  • Power BI
  • PowerShell
  • PowerShell Core
  • Productividad
  • Project Server 2019
  • R
  • Rendimiento
  • Scala
  • Scraper
  • Security
  • Serverless
  • Service Fabric
  • SharePoint Server 2019
  • SignalR
  • Sin categoría
  • Sistemas Distribuidos
  • Skype
  • Skype for Business Server 2019
  • Small Basic Online
  • SQL Server 2005
  • SQL Server 2008
  • SQL Server 2012
  • SQL Server 2014
  • SQL Server 2016
  • SQL Server 2017
  • SQL Server 2019
  • STOMP
  • Swagger
  • Testing
  • TFS 2017
  • TFS 2018
  • Tools
  • TypeScript
  • Unity
  • UWP
  • UX
  • Visio
  • Visual Basic
  • Visual Studio 2010
  • Visual Studio 2012
  • Visual Studio 2013
  • Visual Studio 2015
  • Visual Studio 2017
  • Visual Studio 2017 for Mac
  • Visual Studio 2019
  • Visual Studio 2019 for Mac
  • Visual Studio App Center
  • Visual Studio Code
  • Visual Studio IntelliCode
  • Visual Studio Live Share
  • Visual Studio Live Share Audio
  • Visual Studio Online
  • VS Anywhere
  • Vue.js
  • Web API
  • WebAssembly
  • WinDbg
  • Windows
  • Windows 10
  • Windows Compatibility Pack
  • Windows Phone 10
  • Windows Phone 7
  • Windows Phone 8
  • Windows Server 2008
  • Windows Server 2012
  • Windows Server 2016
  • Windows Server 2019
  • Windows Service
  • WinForms
  • WinUI
  • WPF
  • Xamarin
  • Xbox
  • Xcode
  • Xiaomi Mi Band 2
  • xUnit
  • YAML

Archivos

  • enero 2021
  • diciembre 2020
  • noviembre 2020
  • octubre 2020
  • septiembre 2020
  • agosto 2020
  • julio 2020
  • junio 2020
  • mayo 2020
  • abril 2020
  • marzo 2020
  • febrero 2020
  • enero 2020
  • diciembre 2019
  • noviembre 2019
  • octubre 2019
  • septiembre 2019
  • agosto 2019
  • julio 2019
  • junio 2019
  • mayo 2019
  • abril 2019
  • marzo 2019
  • febrero 2019
  • enero 2019
  • diciembre 2018
  • noviembre 2018
  • octubre 2018
  • septiembre 2018
  • agosto 2018
  • julio 2018
  • junio 2018
  • mayo 2018
  • abril 2018
  • marzo 2018
  • febrero 2018
  • enero 2018
  • diciembre 2017
  • noviembre 2017
  • octubre 2017
  • septiembre 2017
  • agosto 2017
  • julio 2017
  • junio 2017
  • febrero 2015
  • octubre 2014
  • junio 2014
  • marzo 2014
  • febrero 2014
  • enero 2014
  • diciembre 2013
  • septiembre 2013
  • agosto 2013
  • julio 2013
  • junio 2013
  • abril 2013
  • febrero 2013
  • enero 2013
  • diciembre 2012
  • noviembre 2012
  • septiembre 2012
  • agosto 2012
  • junio 2012
  • mayo 2012
  • abril 2012
  • marzo 2012
  • febrero 2012
  • enero 2012
  • diciembre 2011
  • noviembre 2011
  • octubre 2011
  • septiembre 2011
  • agosto 2011
  • julio 2011
  • junio 2011
  • mayo 2011
  • abril 2011
  • marzo 2011
  • enero 2011
  • diciembre 2010
  • noviembre 2010
  • octubre 2010
  • septiembre 2010
  • agosto 2010
  • julio 2010
  • junio 2010
  • mayo 2010
  • abril 2010
  • marzo 2010
  • febrero 2010
  • enero 2010
  • diciembre 2009
  • noviembre 2009
  • octubre 2009
  • septiembre 2009
  • agosto 2009
  • julio 2009
  • junio 2009
  • mayo 2009
  • abril 2009
  • marzo 2009
  • febrero 2009
  • enero 2009
  • diciembre 2008
  • noviembre 2008
  • octubre 2008
  • septiembre 2008
  • agosto 2008
  • julio 2008
  • junio 2008
  • mayo 2008
  • abril 2008
  • marzo 2008
  • febrero 2008
  • enero 2008
  • diciembre 2007
  • noviembre 2007
  • octubre 2007
  • septiembre 2007
  • agosto 2007
  • julio 2007
  • junio 2007
  • mayo 2007
  • abril 2007
  • marzo 2007
  • febrero 2007
  • enero 2007
  • diciembre 2006
  • noviembre 2006
  • octubre 2006
  • septiembre 2006
  • agosto 2006
  • julio 2006
  • junio 2006
  • mayo 2006
About This Site

A cras tincidunt, ut tellus et. Gravida scel ipsum sed iaculis, nunc non nam. Placerat sed phase llus, purus purus elit.

Archives Widget
  • January 2010
  • December 2009
  • November 2009
  • October 2009
Categories
  • Entertainment
  • Technology
  • Sports & Recreation
  • Jobs & Lifestyle
Search
  • twitter

Powered by WordPress  |  Business Directory by InkThemes.

This site uses cookies: Find out more.