Conectar .NET Web API con Azure API Management

Por

Últimamente he estado programando web APIs y me adentré al mundo de Azure API Management para facilitar algunas tareas que a veces resultan difíciles de programar y mantener. Por ejemplo, crear políticas de seguridad, cuotas de llamadas a la API, autorizaciones, servicios como productos, etc. Me resultó interesante lo fácil que fue vincular mi Web API con API Management y todas las herramientas que nos ofrece AAM para desarrollo y mantenimiento en producción.

En esta publicación veremos que vincular una Web API de .NET a Azure API Management y posteriormente crearemos productos, políticas y cuotas para nuestra API.

Pre-Requisitos

Crear Web API como Azure API App

Crear nuevo proyecto Web API como Azure API App en Visual Studio:

Templates –> Visual C# –> Web –> ASP.NET Web Application

image

image

Una vez que tengamos nuestro proyecto creado, vamos a verificar que tengamos en las referencias la librería de “Swashbuckle.Core”, esté paquete nos permitirá generar nuestra definición “Swagger” de nuestra API, así podremos importarla posteriormente en Azure API Management:

image

Veremos en nuestro proyecto un controlador llamado “ValuesController”, este controlador es creado por defult. Al final nuestra API debe de versé algo así (modifiqué el tipo de “response” a IHttpActionResult):

image

Una vez que tengamos nuestra API creada, vamos a desplegarla a Azure API Apps.

Crear recurso Azure API App

Vamos al portal de Azure y buscamos por API App:

image

1

Publicar Web API a Azure API App

Damos clic derecho en nuestro proyecto y hacemos clic en “Publish”, luego seleccionamos: “Microsoft Azure App Services” y por ultimo elegimos nuestro recurso de API App.

image

image

2

image

Finalizamos el proceso dando clic en “Publish” y esperamos a que Visual Studio realice el proceso de deployment. Al finalizar, veremos algo así:

image

Antes de crear nuestro recurso de API Management, vamos a verificar que se creó nuestra definición Swagger con el siguiente enlace: http://webapi-aam-demo.azurewebsites.net/swagger/docs/v1

La forma de obtener el swagger es la siguiente: URL + /swagger/docs/v1

Nota: Swashbuckle es el que crea el recurso de swagger al compilar y/o publicar

Crear servicio de Azure API Management

Vamos al portal de Azure y buscamos por API Management y creamos el recurso. El proceso de creación puede tardar varios minutos, en mi caso esperé 30 min.

image

3

Al finalizar el deployment, podremos abrir nuestro recurso y ver lo siguiente:

4

API Gateway endpoint:

- Acepta llamadas a la API y las enruta a tu backend.
- Verifica las API Keys, JWT Tokens, Certificados y otras credenciales.
- Aplica cuotas de uso y límites de tarifas.
- Transforma tu API al vuelo sin modificación de código.
- Cache de respuestas de backend cuando se habilita.
- Crea un log de metadata para propósitos de análisis.

 

Publisher Portal:

Es una interface administrativa donde se hace la configuración y creación de los programas API.

- Define o importa el squema de la API.
- Empaqueta APIs en productos.
- Crea políticas como cuotas o transformaciones en la API.
- Obtiene información para analíticos.

Developer Portal:

Sirve como portal principal para el desarrollador, donde puede:

- Leer documentación de la API.
- Probar una API vía consola interactiva.
- Crear una cuenta y subscribirse a un producto para obtener API Keys.
- Acceder a analíticos de su propio consumo.

Para conectar nuestra API a API Management, necesitamos acceder al portal de publicador (Publisher Portal).

Importar API a API Management desde el portal de publicador

Ingresamos al portal de publicador y damos clic en “Import API”5

Ahora vamos a realizar los siguientes pasos:

1. Elegir importar “From URL”

2. Elegir el formato “Swagger”

3. Agregar la URL de nuestro squema Swagger de la Web API que desplegamos en Azure anteriormente:

http://webapi-aam-demo.azurewebsites.net/swagger/docs/v1

4. Agregar sufijo a nuestra API (opcional)

5. Agregar productos a los que vamos a relacionar con nuestra API.

 6

Damos clic en “Save” y API Management va a crear nuestra definición.

Ahora podemos ir a la sección de “APIs” y veremos nuestra API ya creada:

image

image

Si vamos a la pestaña de “Operations”, veremos nuestros métodos anteriormente definidos en nuestra API:

image

Probar API desde el portal de desarrollador

Para ir al portal de desarrollador, damos clic en “Developer Portal” en la esquina superior derecha de nuestra pantalla:

7

Una vez en el portal de desarrollador, vamos a dar clic en “APIs” y luego vamos a nuestra API que desplegamos en API Management:

8

image

image

Vemos que todo se ve en orden, y tenemos nuestras operaciones disponibles en la API.

Si vamos a la parte inferior de la página, veremos ejemplo de código, para consumir desde un cliente:

image

Para probar la API, vamos a dar clic en el botón “Try it”

image

Ahora en la parte inferior damos clic en el botón “Send” para realizar el request a nuestra operación seleccionada:

image

image

Éxito! hemos logrado vincular nuestra Web API a API Management, ahora podremos disfrutar de los servicios de Azure API Management.

Próximos pasos:

    • Crear productos, políticas de limites y cuotas en API Management

Saludos a todos!

Comments

Post a Comment

Popular posts from this blog

Despliegue de contenedores Docker a Azure Web Apps

Por
Image
En esta publicación veremos como realizar un despliegue de una contenedor de Docker al nuevo servicio de Azure llamado: Azure Web Apps on Linux Veremos también como crear un contenedor de Docker con Visual Studio y almacenaremos una aplicación de .NET Core en el contenedor. Pre-requisitos Tener una suscripción de Azure si no tienes una, puedes obtener un free trial Visual Studio 2015 Update 3, obtenerlo aquí . Docker for Windows Visual Studio Tools for Docker Microsoft .NET Core 1.0.1 RTM VS 2015 Tooling Preview 2, with the 1.0.1 updates Crear proyecto .NET Core Para crear una aplicación de .NET Core y luego almacenarla en un contenedor de Docker, podemos revisar mi publicación: Como crear una aplicación .NET Core y almacenarla en un contenedor de Docker usando Visual Studio Seguir los pasos de esa publicación para luego hacer un despliegue de nuestro contenedor a Azure Web Apps on Linux. App Services Web Apps en Linux + Docker Hace pocas semanas...
Read more

.NET Web API output cache con Azure Redis Cache

Por
Image
En esta publicación veremos como conectar una Web API de .NET a Azure Redis Cache. El objetivo es decorar nuestros métodos web para que las respuestas que son concurrentes se obtengan del servicio de cache de Azure Redis Cache y no tener que ir siempre a una base de datos. La manera en la que vamos a implementar esta solución es codificando un "middleware" en nuestra Web API, interceptando únicamente los "request" de los métodos que nosotros deseamos implementar cache. Una vez que interceptamos los request, verificamos en Redis mediante un Key, si no existe registro, dejamos que nuestro método haga su operación normal, despues, al final del proceso, obtenemos el "response" y lo guardamos en Redis con alguna Key que identifique el registro para luego obtenerlo de cache cuando se requiera. Pre-requisitos Visual Studio , obtenerlo aquí . Tener una suscripción de Azure si no tienes una, puedes obtener un free trial Descargar código aquí:...
Read more

Geospatial queries in Azure Redis Cache using Node.js Azure API App

Por
Image
Hello world! Now I come with a guide on how to perform geospatial queries in Azure Redis Cache using Redis for Node.js. To create our environment, we will perform the following steps: Create Redis server in Azure Create API App in App Services Create Node.js Web API in Visual Studio Publish Node.js API in Azure App Services Test API with Rest Client Download code here: Https://github.com/Kodran/Redis-Geospatial-WebAPI Pre requirements Azure subscription, you can get a free trial here Visual Studio 2013+ Node.js and npm Node.js Visual Studio Tools Https://www.visualstudio.com/en/vs/node-js/ Node.js Redis Client Npm install redis Create Redis server in Azure Enter to the Azure portal and look for: "Redis Cache", then add a Redis server and capture the data of the new server: For demonstration reasons, we will choose a standard server, remember that if we want to configure a Redis cluster or make more advanced configurations, we need...
Read more

Integrar Web API de .NET en proyecto de Xamarin.Forms utilizando Visual Studio y Azure API App

Por
Image
Nota: Este post es la continuación de la guía: Integración Continua para Android Xamarin.Forms usando VS Team Services, VS Source Control y VS Mobile Center , favor de realizar primero los paso del post antes de seguir con esta publicación. Para crear una aplicación altamente disponible, escalable y tolerante a errores, vamos a crear una Web API para luego conectarla con nuestra aplicación y después desplegaremos la API en Azure para obtener todos los beneficios de una infraestructura de nube. Pre-Requisitos Visual Studio 2015+ Cuenta en Visual Studio Team Services Xamarin instalado en Visual Studio Iniciar sesión en https://mobile.azure.com con tu cuenta de Microsoft Completar la guía: Integración Continua para Android Xamarin.Forms usando VS Team Services, VS Source Control y VS Mobile Center   Crear Web API como Azure API App Antes que nada, creamos una carpeta de solución llamada: “Azure.AppService” y posteriormente agregamos un nuevo proyecto Web API como Azu...
Read more