Pasarela API de Amazon con .NET

En este artículo completo, aprenderemos sobre Amazon API Gateway con la pila .NET. Con esto, podremos exponer AWS Lambdas al mundo exterior con bastante facilidad.

En un artículo anterior, aprendimos sobre cómo trabajar con AWS Lambda usando .NET, que es un punto vital para comenzar con las aplicaciones sin servidor. Si bien construimos e implementamos esos Lambdas en AWS, en realidad nunca discutimos cómo los expondríamos para que los invoque el mundo externo.

Más adelante en esta guía completa, crearemos una aplicación sin servidor completa que se integre a la perfección entre Amazon API Gateway, Lambda, DynamoDb para persistencia y Cloudwatch para fines de registro.

Puede encontrar el código fuente de la implementación aquí .

¿Qué es la puerta de enlace API de Amazon?

Amazon API Gateway es un servicio completamente administrado que le permite crear puertas de enlace, que esencialmente sirven como una puerta a su mundo de lógica comercial para su aplicación. Con este servicio, básicamente expone puntos finales que, al acceder, se conectan a AWS Lambdas, puntos finales públicos y varios otros servicios de AWS, según la forma en que cree Amazon API Gateway.

Digamos que alguna aplicación que se ejecuta en Internet necesita acceso a la lógica comercial que permanece dentro de su lambda. Estas aplicaciones cliente se conectarían a Amazon API Gateway, que internamente redirigiría la solicitud al AWS Lambda asociado u otros servicios que hubiera configurado.

Veamos una representación esquemática de cómo se vería un flujo de solicitud común a través de una API Gateway.

Pasarela API de Amazon con .NET

Como puede ver, los clientes acceden a la puerta de enlace que está conectada internamente a un servicio. Por ejemplo,

  • www.<url-of-aws-gateway>/test -> redirigiría a una lambda llamada test-lambda
  • www.<url-of-aws-gateway>/get-students -> redirigiría a una lambda que devuelve la lista de estudiantes
  • www.<url-of-aws-gateway>/weather?city=trivandrum -> redirigiría a un punto final de la API meteorológica pública que devolvería los datos meteorológicos de la ciudad de Trivandrum.

Ahora, API Gateways es a menudo una parte vital de todo el ecosistema sin servidor de AWS, ya que hace que sea genial y fácil acceder a nuestros servicios de AWS a cualquier escala.

API REST de AWS frente a API HTTP

AWS admite dos versiones de API Gateway Services. El lanzamiento inicial fue para la variante API REST que incluye toneladas de características para diseñar, desarrollar y mantener su puerta de enlace API. Más tarde, alrededor de 2019, AWS presenta las API HTTP que simplificaron la creación e implementación de Gateway. No se confunda con el nombre, ambas versiones se basan en el protocolo HTTP siguiendo las convenciones REST. AWS los nombra internamente como v1 (API REST) ​​y v2 (API HTTP)

Existen muchas diferencias significativas entre estas versiones, incluido el rendimiento, el precio y la experiencia de desarrollo. En resumen, HTTP Apis gana en casi todos los departamentos y debería ser su elección la mayor parte del tiempo.

  • En primer lugar, las API HTTP están destinadas a tener un mejor rendimiento y son casi un 10-15 % más eficaces en comparación con la API REST.
  • En términos de precios, para los primeros 300 millones de solicitudes por mes, las API HTTP le costarían solo 1 USD, mientras que, para el mismo volumen, las API REST costarían alrededor de 3,5 USD. Esta es una gran diferencia. Tenga en cuenta que la capa gratuita de AWS incluye 1 millón de API (REST y HTTP) por mes durante los primeros 12 meses absolutamente gratis. Tiempo suficiente para explorar estas dos tecnologías geniales, ¿verdad?
  • La experiencia de usuario que ofrece la consola de AWS al desarrollar estas puertas de enlace es completamente diferente entre sí.
  • La API REST admite puntos finales optimizados para el perímetro que garantizan que sus puntos finales estén altamente distribuidos en todo el mundo, mientras que los puntos finales HTTP solo admiten implementaciones regionales, lo que podría contribuir a un ligero retraso en las respuestas.
  • Ambos son de naturaleza altamente segura.
  • Las implementaciones canarias se incluyen con la API REST y no con las API HTTP si esto es un gran problema para su estrategia de implementación.

Para obtener más comparaciones, consulte la guía para desarrolladores de AWS que compara ambas versiones. Aunque las API HTTP son más baratas que REST, ciertamente hay muchas funciones incluidas en la API REST que justifican la diferencia de precio.

En cuanto a nuestra demostración, usaremos API HTTP. Tal vez en un artículo posterior, exploraremos las API REST. En cuanto al concepto, ambos son casi iguales. Usaremos Visual Studio 2022 Community junto con la extensión AWS SDK Kit como hicimos en el artículo anterior sobre Lambda para desarrollar, probar, simular y publicar nuestras Lambdas en la nube de AWS.

Es importante que ya haya leído el artículo anterior sobre AWS Lambda en .NET, donde configuramos las credenciales de AWS a través de la CLI, instalamos el kit de herramientas de AWS en Visual Studio Code. Si no es así, consulte esta publicación de blog.

Creación y publicación de un AWS Lambda con .NET

Primero, abramos Visual Studio 2022 y creemos una solución en blanco. Nombré mi solución como AWSServerless.Dotnet.Demo . Básicamente, tendremos 2 proyectos Lambda en esto, que iremos agregando gradualmente.

  1. Una Lambda ficticia que devuelve un mensaje de saludo. Esta lambda se usará para presentar los conceptos básicos de integración de Amazon API Gateway y otras cosas.
  2. Una Lambda de estudiante, a la que agregaremos varios controladores de función que posiblemente puedan realizar algunas operaciones CRUD básicas contra DynamoDB. (PD, he escrito un artículo sobre Primeros pasos con DynamoDB usando .NET. Échale un vistazo también).

Antes de continuar, asegúrese de tener lo siguiente en su lugar.

  • Configuración de credenciales de AWS a través de la CLI de AWS.
  • AWS Toolkit instalado en su instalación de Visual Studio.
  • Tener una cuenta de AWS. Un nivel gratuito sería más que suficiente.

Puede obtener más información relacionada con los pasos anteriores en mis artículos anteriores sobre aplicaciones sin servidor de AWS con .NET.

crear un proyecto en blanco aws sin servidor Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Agreguemos nuestro primer proyecto Lambda a nuestra solución en blanco. Haga clic con el botón derecho en la solución en Visual Studio y presione Agregar nuevo proyecto. Suponiendo que ya instaló AWS Toolkit en su instancia de Visual Studio, puede buscar AWS Lambda en la ventana emergente "Agregar un nuevo proyecto" que aparece.

devenv iArkd7DjVv Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Haga clic en Siguiente. Aquí vamos a nombrar la lambda HelloLambda. Como se mencionó anteriormente, esta será una lambda simple que nos ayudaría a comprender cómo sería toda la integración con Amazon API Gateway con .NET. Cuando se le pida que seleccione un modelo para su nueva lambda, seleccione "Función vacía". Esto nos da una pizarra limpia para comenzar a construir nuestro Lambda simple.

Ya estará familiarizado con la estructura de carpetas del Proyecto AWS Lambda. Si no, lea este artículo. Abra Function.cs / FunctionHandler. Ahora que vamos a adjuntar este controlador con nuestra API Gateway, debemos realizar algunas pequeñas modificaciones en la firma de este método. Pero antes de eso, instalemos un paquete en este proyecto de Lambda que contenga los contratos. Puede abrir la Consola del administrador de paquetes y ejecutar lo siguiente para instalar el paquete.

Install-Package Amazon.Lambda.APIGatewayEvents

Vayamos y cambiemos nuestro FunctionHandler ahora.

public APIGatewayHttpApiV2ProxyResponse FunctionHandler(APIGatewayHttpApiV2ProxyRequest request, ILambdaContext context)
{
request.QueryStringParameters.TryGetValue("name", out var name);
name = name ?? "John Doe";
var message = $"Hello {name}, from AWS Lambda";
return new APIGatewayHttpApiV2ProxyResponse
{
Body = message,
StatusCode = 200
};
}

APIGatewayHttpApiV2ProxyRequest representa la solicitud entrante de una API HTTP. Si lo piensa, o si mira hacia atrás en el primer diagrama de flujo que teníamos, la solicitud que recibe Lambda no es directamente del cliente, sino una solicitud del mismo Amazon API Gateway. Entonces, en este caso, API Gateway envía una solicitud a Lambda con el tipo APIGatewayHttpApiV2ProxyRequest . De manera similar, APIGatewayHttpApiV2ProxyResponse es el tipo de respuesta que Lambda devuelve a Amazon API Gateway. También puede omitir esta parte de respuesta y, en su lugar, devolver algunos datos cruciales como requisito comercial, como una lista de Estudiantes, que haremos mientras construimos nuestro próximo Lambda más adelante en esta guía.

Estos fueron los principales cambios en Lambda para admitir todo el asunto de la integración de API Gateway. Aparte de eso, el controlador de funciones ahora devuelve un mensaje que dice "Hola {nombre}, de AWS Lambda". Otra cosa aquí es que, desde Lambda, puede acceder al contexto entrante, que incluye cadenas de consulta, parámetros de ruta, rutas, etc. Para este Lambda, espero que la solicitud entrante tenga un parámetro de consulta de nombre (…/hello?name=Mukesh), que luego se agregará al mensaje que finalmente devuelve.

Si el parámetro de consulta no existe, continúa con el nombre predeterminado, que es John Doe. Tenga en cuenta que estamos devolviendo la respuesta como tipo APIGatewayHttpApiV2ProxyResponse, donde Body es el mensaje real, y proporcionamos un código de estado de 200 SUCCESS.

Eso es todo para nuestra Primera Lambda. Publicémoslo en AWS y hagamos una prueba simulada localmente dentro de Visual Studio. Haga clic derecho en el proyecto HelloLambda y haga clic en Publicar en AWS Lambda. Verá la siguiente ventana emergente.

image Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

La herramienta completa automáticamente los primeros detalles, dado que ha configurado sus Credenciales, región y perfil locales de AWS.

  • El nombre de la función es el nombre con el que se identificará Lambda en su cuenta de AWS.
  • Descripción: como sugiere el nombre.
  • El controlador es un poco importante aquí. Digamos que su Function.cs puede tener potencialmente múltiples métodos de controlador. Este método de controlador se asigna a la función exacta a la que necesita que apunte su Lambda. En nuestro caso, es HelloLambda::HelloLambda.Function::FunctionHandler. Tenga esto en cuenta, ya que utilizaremos este campo más adelante en nuestro artículo.

Haga clic en Siguiente.

devenv oEzQI2HY6h Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

En la siguiente pantalla, el único cambio que tendrá que hacer es seleccionar el rol correcto necesario. En nuestro caso, es AWSLambdaBasicExecutionRole. Esto viene con permisos para escribir registros en AWS Cloudwatch. Eso es todo. Haga clic en Cargar. AWS comienza a crear los roles necesarios, ejecuta algunos comandos para crear y lanzar su Lambda localmente, comprime las bibliotecas publicadas y las carga en AWS, que finalmente crea su nueva Lambda brillante.

Amazon API Gateway con .NET: integraciones de AWS Lambda y DynamoDB

Una vez hecho esto, puede abrir la Consola de administración de AWS, navegar a Lambdas y verificar que se haya creado nuestro nuevo Lambda.

imagen 2 Amazon API Gateway con .NET: integraciones de AWS Lambda y DynamoDB

De vuelta en Visual Studio, puede ver que el Asistente de publicación habría abierto una pequeña herramienta que ayuda a probar nuestro Lambda directamente de Visual Studio. Ah, y si aún no lo sabe, también puede simplemente ejecutar la aplicación Lambda en modo de depuración, y Visual Studio activaría una herramienta simulada que esencialmente ayuda a probar y depurar su código Lambda.

Por ahora, exploremos la herramienta integrada en la interfaz de Visual Studio. Aquí hay una captura de pantalla a continuación.

imagen 1 Amazon API Gateway con .NET: integraciones de AWS Lambda y DynamoDB

En primer lugar, esta interfaz le permite enviar solicitudes simuladas directamente a su Lambda que se implementó en AWS. Haga clic en el menú desplegable Solicitud de ejemplo y seleccione API Gateway AWS Proxy. La herramienta llenaría una solicitud de muestra. Aquí, como hice yo, puede agregar una clave/valor de nombre a los parámetros de la cadena de consulta. Hay bastantes propiedades para jugar por aquí. Una vez que haga clic en Invocar, la respuesta tendrá nuestro mensaje con un código de estado de 200.

Ahora, aunque Lambda está listo, realmente no tenemos otra forma de acceder a esta función que no sea desde las herramientas de depuración de VS. Por lo tanto, necesitamos un enlace/punto final al que enviamos una solicitud, y esperamos una solicitud similar de Lambda. Aquí es donde Amazon API Gateway entra en escena.

Creación de Amazon API Gateway con .NET

Comencemos a diseñar nuestro primer Amazon API Gateway. Busque API Gateway en la barra de búsqueda que ve en la Consola de administración de AWS. Verá la página de destino predeterminada para Amazon API Gateway. Aquí se le presentarán opciones para seleccionar un tipo de API. Dado que usaremos la API HTTP, hagamos clic en el botón Generar asociado.

chrome HZudzLTStT Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Dado que nuestro Lambda se creó con éxito, puede seleccionar el tipo de integración como Lambda y elegir nuestra función hello Lambda. Asegúrese de ceñirnos a la versión 2.0 de la carga útil, ya que es la última. Además, asegúrese de seleccionar la región de AWS correcta. En mi caso es ap-sur-1. Con eso hecho, haga clic en siguiente.

chrome ZaswQgDPsT Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Luego viene una parte interesante, donde configuramos las rutas reales que pueden invocar nuestro hola Lambda. Puede ver que lo convertí en un método GET que tendrá un punto final de /hello y apuntará a Hello Lambda. Básicamente, una vez que creamos la puerta de enlace API, AWS nos proporcionará una URL de punto final, a la que si agregamos /hello y enviamos un método GET con los parámetros de consulta apropiados, se activará Lambda y devolverá la respuesta deseada.

Tenga en cuenta que puede realizar múltiples rutas e integraciones aquí. Exploraremos esto cuando creemos nuestra API Gateway completa más adelante en este artículo.

chrome 1j5EYx3xWe Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

A continuación, el Asistente nos pedirá que creemos etapas. Esto será útil si queremos implementar nuestra API Gateway de Amazon en diferentes etapas, como desarrollo, producción y preparación. Pero por ahora, mantengamos el valor predeterminado, que es `$default`, y hagamos clic en Siguiente.

Aquí puede revisar sus cambios e implementar su puerta de enlace. Eso es todo, tan simple como eso.

En la siguiente pantalla, puede ver la URL de Amazon API Gateway que acabamos de crear. Copie esto y abra Postman o cualquier herramienta de prueba de API que use. Además, dado que es solo un método GET, puede incluso usar el navegador para probar nuestro Gateway.

chrome kmkvkIZHmM Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Probemos cómo respondería nuestra API Gateway. Usaré Postman para las pruebas. Asegúrese de que sea un método GET, de lo contrario, Gateway gritará que no se encuentra dicho punto final.

En la siguiente captura de pantalla, puede ver que envié una solicitud al punto final /hello y pasé el nombre del parámetro de consulta como mi Nombre, y también puede ver la respuesta esperada de Lambda. Bastante simple, ¿verdad? Siéntase libre de jugar con Hello Lambda para comprender más al respecto.

Postman 09XFb6JnKd Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Exploración de la interfaz de la consola de Amazon API Gateway

Ahora que hemos creado nuestro primer Amazon API Gateway con AWS Lambdas con tecnología .NET, exploremos la interfaz y las características proporcionadas en Amazon API Gateway.

En la página de inicio, puede ver una lista de puertas de enlace creadas por usted en una región específica de AWS.

chrome RYg52eeVpW Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Una vez que ingresa a una puerta de enlace API específica, obtiene acceso a un montón de funciones interesantes para modificar su puerta de enlace.

chrome C3lh3VJBk3 Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Desde aquí, se llega a:

  • Agregue más rutas a un Amazon API Gateway existente.
  • Protección de Amazon API Gateway mediante Lambdas y JWT. ¡Profundizaremos en esto en el próximo artículo!
  • Administra integraciones y Lambdas.
  • Configure las políticas de CORS.
  • Exportar/Importar definiciones de OpenAPI.
  • Escriba registros de acceso si es necesario. Por lo tanto, cada vez que se envía una solicitud a través de la puerta de enlace API, la solicitud se registra en Cloudwatch. Tendrá que especificar un destino de grupo de registro para esto. Veremos esto más adelante en el artículo.
  • Administrar/Crear etapas, etc.

Ahora que tenemos una comprensión básica de cómo funciona Amazon API Gateway con .NET, construyamos una aplicación sin servidor más avanzada que utilice AWS Lambda, controladores de funciones múltiples, Cloudwatch, DynamoDB para almacenar datos y, finalmente, integremos todos estas Lambdas utilizando una puerta de enlace API de Amazon.

Creación de gestión de estudiantes AWS Lambda con .NET

Construiremos una API simple que puede obtener todos los detalles de los estudiantes, obtener estudiantes por identificación y crear un nuevo registro de estudiante. Agregue un nuevo proyecto de Lambda a nuestra solución y asígnele el nombre StudentLambda. Y sí, crearemos varias Lambdas a partir de un único proyecto Lambda. Eres libre de crear proyectos separados para cada una de las funciones. Pero para el alcance actual de la aplicación y el requisito, no es realmente necesario. Rellenaremos las 3 funciones Lambda en un solo proyecto .NET Lambda y utilizaremos FunctionHandlers para implementar por separado todas las Lambdas en AWS.

Antes de comenzar, asegúrese de instalar los siguientes paquetes Nuget en su proyecto StudentLambda a través de la Consola del administrador de paquetes.

Install-Package Amazon.Lambda.APIGatewayEvents
Install-Package AWSSDK.DynamoDBv2
Install-Package Newtonsoft.Json

Como sabe, el primer paquete es específicamente para usar los contratos de Amazon API Gateway dentro de nuestro .NET Lambda.

El paquete DynamoDB permite que nuestro Lambda se comunique con nuestro DynamoDB. Si no sabe cómo funciona DynamoDB, he escrito una guía completa al respecto aquí . He creado una CRUD ASP.NET Core WebAPI simple que almacena datos en una tabla de AWS DynamoDB.

A continuación, definamos el modelo de estudiante. Con la raíz del proyecto StudentLambda, agregue una nueva clase y asígnele el nombre Student.cs

namespace StudentLambda
{
[DynamoDBTable("students")]
public class Student
{
[DynamoDBHashKey("id")]
public int? Id { get; set; }
[DynamoDBProperty("first_name")]
public string? FirstName { get; set; }
[DynamoDBProperty("last_name")]
public string? LastName { get; set; }
[DynamoDBProperty("class")]
public int Class { get; set; }
}
}

Ahora navegue a AWS DynamoDB y cree una nueva tabla allí como la siguiente.

chrome FCz71W3ljT Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Una vez que cree la tabla, AWS tardará un par de segundos en aprovisionar la tabla en la nube. Agreguemos un registro de muestra a esta tabla. Abra la tabla, presione Explorar elementos de la tabla -> Crear elemento.

Cambie a la vista JSON y agregue un registro de muestra como el siguiente. Tenga en cuenta que las propiedades que he usado son exactamente las mismas que definimos en nuestra clase Student.cs. Haz clic en Crear.

{
"id": 1,
"first_name" : "Mukesh",
"last_name" : "Murugan",
"class" : 10
}

chrome MotUEEQAR1 Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Obtener todos los estudiantes

Escribamos algo de código para devolver una lista de todos los estudiantes de la tabla de DynamoDB. Abra la clase Function.cs de StudentLambda. Elimina el método FunctionHandler predeterminado. y agregue la siguiente función.

public async Task<List<Student>> GetAllStudentsAsync(APIGatewayHttpApiV2ProxyRequest request, ILambdaContext context)
{
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
DynamoDBContext dbContext = new DynamoDBContext(client);
var data = await dbContext.ScanAsync<Student>(default).GetRemainingAsync();
return data;
}

Entonces, esta función esencialmente escanea toda la tabla de DynamoDB, nombra a los estudiantes y devuelve una lista de estudiantes. Tan simple como eso. Tenga en cuenta que crearemos un par de clientes y contextos de DynamoDB para acceder a nuestros datos desde AWS Lambda.

Implementaremos estos Lambdas una vez que se completen los 3. Idealmente, el punto final para este Lambda será <amazon-url>/students [GET] Method.

Crear estudiante

A continuación, a Same Function.cs de Student Lambda, agreguemos otro método que se encargará de crear nuevos registros de estudiantes. A continuación se muestra la función.

public async Task<APIGatewayHttpApiV2ProxyResponse> CreateStudentAsync(APIGatewayHttpApiV2ProxyRequest request, ILambdaContext context)
{
var studentRequest = JsonConvert.DeserializeObject<Student>(request.Body);
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
DynamoDBContext dbContext = new DynamoDBContext(client);
await dbContext.SaveAsync(studentRequest);
var message = $"Student with Id {studentRequest?.Id} Created";
LambdaLogger.Log(message);
return new APIGatewayHttpApiV2ProxyResponse
{
Body = message,
StatusCode = 200
};
}

Entonces, aquí esperamos que el cliente envíe un cuerpo JSON con detalles del estudiante.

Línea #3, deserializamos el cuerpo de la solicitud entrante en un objeto Student. Luego creamos un contexto de base de datos para acceder a la tabla dynamoDb y guardamos el registro del estudiante en nuestra base de datos. Una vez hecho esto, devolveremos un mensaje de éxito al cliente como respuesta con un código de estado de 200.

En la línea 8, puede notar que estamos usando una instancia de LambdaLogger para registrar el mensaje en Cloudwatch LogGroup de Lambda. Idealmente, este punto final será el método <amazon-url>/students [POST].

Obtener estudiante por ID

Avanzando hacia nuestra última función lambda, agreguemos una función que pueda devolver estudiantes según la identificación enviada en la solicitud. Esta será una función algo diferente, ya que tendremos que obtener la ID del parámetro de ruta de la solicitud. Por ejemplo, este punto final de implementación se vería como <amazon-url>/students/{id}.

Copie y pegue el siguiente método en Function.cs del proyecto Student Lambda.

public async Task<Student> GetStudentByIdAsync(APIGatewayHttpApiV2ProxyRequest request, ILambdaContext context)
{
AmazonDynamoDBClient client = new AmazonDynamoDBClient();
DynamoDBContext dbContext = new DynamoDBContext(client);
string idFromPath = request.PathParameters["id"];
int id = Int32.Parse(idFromPath);
var student = await dbContext.LoadAsync<Student>(id);
if (student == null) throw new Exception("Not Found!");
return student;
}

En línea #5, estamos extrayendo el ID de estudiante de la propiedad de parámetros de ruta de la solicitud. Una vez que lo recuperamos, lo convertimos en un número entero y lo pasamos al método dynamoDb para obtener el ID del estudiante. Este registro de estudiante se devuelve al cliente como respuesta.

Ahora, todas las funciones de Lamda están creadas. Implementémoslos en AWS.

En Visual Studio, haga clic con el botón derecho en el proyecto StudentLambda y haga clic en Publicar en AWS Lambda. Desplegaremos cada una de las 3 funciones, una tras otra.

Hay 2 puntos a tener en cuenta en la siguiente pantalla. El nombre de la función es "get-all-students" y el controlador apunta al método GetAllStudentsAsync. Así publicamos por separado todas las 3 Lambda. Debes haber captado la idea a estas alturas. Una vez que se cambien estos campos, haga clic en Siguiente.

devenv lP4870ufPw Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

En la siguiente pantalla, deberá seleccionar el rol asociado con este Lambda. Para empezar, puede ser AWSLambdaBasicExecution Role. Sin embargo, hay un problema con esto. Este rol en particular brinda acceso solo para ejecutar Lambda y escribir los registros en Cloudwatch. Pero no hay permiso para acceder a nuestra tabla de DynamoDB, ¿verdad? Arreglaremos esto después de implementar todas las Lambdas.

devenv k3q9el3o6D Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Eso es todo, cargue el Lambda get-all-students.

Repita pasos similares para implementar las Lambdas restantes. Asegúrese de elegir el Rol ya creado para cada uno de estos 2 AWS Lambda.

devenv 12JZFkHk21 Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

devenv fycfsY0BNP Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

devenv jD6jBn30hv Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

¡Eso es todo! Aquí están las Lambdas que creamos hasta ahora.

chrome yqXn6ON0rX Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Adición de permisos de DynamoDB.

Como se mencionó, agreguemos los permisos de DynamoDB requeridos al rol que creamos. Navegue a AWS IAM. Vaya a Políticas y cree una con la siguiente especificación. Como puede ver aquí, seleccionamos DynamoDB como el servicio de AWS y permitimos todas las acciones de DynamoDB, así como todos los recursos.

chrome Ql3GcGoy6E Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Tenga en cuenta que no siempre es una buena idea otorgar permisos completos a un rol en particular. Pero para simplificar las cosas, lo estamos haciendo. No debería hacer esto para aplicaciones de producción. Otorgue solo los permisos que realmente se requieren.

En la página siguiente, asigne un nombre a la política y créela.

chrome ycODtFF4xn Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Ahora que hemos creado la política, anexémosla a nuestros Roles. Seleccione la política recién creada de la lista y haga clic en adjuntar. En la página siguiente, deberá seleccionar el rol/usuario/grupo al que desea adjuntar esta política.

chrome BXL706oAoM Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

En nuestro caso, es lambda_exec_get-all-students

chrome mAu7ftXH2A Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Ahí tienes Adjuntamos con éxito la política al rol que utiliza nuestro AWS Lambda. Ahora Lambda debería tener suficientes permisos para trabajar con DynamoDb.

Conexión de Amazon API Gateway con .NET AWS Lambda

Luego viene la parte crucial de la guía, construir realmente una API Gateway que active cada una de estas lambdas. Abra Amazon API Gateway desde la Consola de administración de AWS.

Hasta ahora, hemos creado solo una API Gateway que es hello . Cree una nueva puerta de enlace API. Como de costumbre, seleccione el tipo de API HTTP y presione Build.

Nombramos a nuestro Gateway como estudiantes y agregamos las 3 Lambdas como integraciones. Sencillo, ¿verdad?

chrome j6Rwc9eHTU Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

En la página siguiente, configuraremos nuestras rutas. Cambiaremos los valores predeterminados y agregaremos la siguiente configuración.

chrome HTdaHTJd1a Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

  • GET /students invocaría get-all-students
  • GET /students/{id} invocaría get-student-by-id donde id es el parámetro de ruta de la solicitud. Por ejemplo, /estudiantes/1
  • Finalmente, POST /students crearía un nuevo estudiante, dado que hemos pasado los detalles del nuevo estudiante como una carga JSON de la solicitud.
     

Deje el escenario como predeterminado y continúe creando la puerta de enlace.

chrome b5Pqmem97h Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Ahí tienes, eso es todo. Probemos este punto final con Postman.

En primer lugar, estoy probando la Lambda get-al-students. Envié una solicitud GET a <url>/students. Como era de esperar, verá una lista de estudiantes como respuesta. Por ahora, solo tenemos un registro en nuestra base de datos.

Postman IEQHc2RddV Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

A continuación, probemos la Lambda get-student-by-id. Envié una solicitud GET a <url>/students/1. Y correctamente devuelve los detalles del estudiante con Id 1.

Postman Z6R9hqnoka Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Finalmente, vamos a crear un nuevo estudiante. Envió una solicitud POST al extremo <url>/students junto con los detalles del estudiante. ¡Y la respuesta es que nuestro Estudiante se crea con ID 2!

Postman 7lDzMoDjEr Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Además, ¿recuerda que escribimos un pequeño registrador en nuestro Create-Student Lambda? Naveguemos a Cloudwatch / Log Groups / create-student y verifiquemos los registros.

chrome kBWX1ReSVr Amazon API Gateway con .NET - Integraciones de AWS Lambda y DynamoDB

Puede ver que nuestro mensaje de registro también se imprime aquí.

Eso es un final para este artículo completo. En el próximo artículo, aprenderemos a proteger API Gateway con Lambda Authorizer. Por ahora, la puerta de enlace API que creamos es un punto final público.

SUGERENCIA importante: asegúrese de eliminar siempre los recursos de AWS que creó una vez que haya terminado de explorarlos. Esto ayuda a reducir los costos incurridos, aunque el nivel GRATUITO le brinda una cantidad bastante decente de solicitudes GRATUITAS para trabajar.

Resumen

En este artículo, aprendimos cómo comenzar con Amazon API Gateway con .NET. Aquí aprendimos sobre la creación de Lambdas básicas que son compatibles con Amazon API Gateway, su integración en DynamoDB, la adición de varias Lambdas a una puerta de enlace en particular, el registro y mucho más. Esto le dará una idea sólida para trabajar con la aplicación sin servidor de AWS. Como la siguiente parte de esta aplicación sin servidor de AWS con .NET, exploraremos cómo asegurar las puertas de enlace de API y cómo trabajar con SAM y mucho más. Manténganse al tanto. Puede seguir este boletín para recibir notificaciones cuando publique nuevos artículos: https://www.getrevue.co/profile/iammukeshm

Comparta este artículo con sus colegas y círculos de desarrollo si lo encuentra interesante. Puede encontrar el  código fuente del proyecto  aquí. ¡Gracias!  

 Fuente: https://codewithmukesh.com/blog/amazon-api-gateway-with-dotnet/

#dotnet #amazon #api 

What is GEEK

Buddha Community

Pasarela API de Amazon con .NET
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

Top 10 API Security Threats Every API Team Should Know

As more and more data is exposed via APIs either as API-first companies or for the explosion of single page apps/JAMStack, API security can no longer be an afterthought. The hard part about APIs is that it provides direct access to large amounts of data while bypassing browser precautions. Instead of worrying about SQL injection and XSS issues, you should be concerned about the bad actor who was able to paginate through all your customer records and their data.

Typical prevention mechanisms like Captchas and browser fingerprinting won’t work since APIs by design need to handle a very large number of API accesses even by a single customer. So where do you start? The first thing is to put yourself in the shoes of a hacker and then instrument your APIs to detect and block common attacks along with unknown unknowns for zero-day exploits. Some of these are on the OWASP Security API list, but not all.

Insecure pagination and resource limits

Most APIs provide access to resources that are lists of entities such as /users or /widgets. A client such as a browser would typically filter and paginate through this list to limit the number items returned to a client like so:

First Call: GET /items?skip=0&take=10 
Second Call: GET /items?skip=10&take=10

However, if that entity has any PII or other information, then a hacker could scrape that endpoint to get a dump of all entities in your database. This could be most dangerous if those entities accidently exposed PII or other sensitive information, but could also be dangerous in providing competitors or others with adoption and usage stats for your business or provide scammers with a way to get large email lists. See how Venmo data was scraped

A naive protection mechanism would be to check the take count and throw an error if greater than 100 or 1000. The problem with this is two-fold:

  1. For data APIs, legitimate customers may need to fetch and sync a large number of records such as via cron jobs. Artificially small pagination limits can force your API to be very chatty decreasing overall throughput. Max limits are to ensure memory and scalability requirements are met (and prevent certain DDoS attacks), not to guarantee security.
  2. This offers zero protection to a hacker that writes a simple script that sleeps a random delay between repeated accesses.
skip = 0
while True:    response = requests.post('https://api.acmeinc.com/widgets?take=10&skip=' + skip),                      headers={'Authorization': 'Bearer' + ' ' + sys.argv[1]})    print("Fetched 10 items")    sleep(randint(100,1000))    skip += 10

How to secure against pagination attacks

To secure against pagination attacks, you should track how many items of a single resource are accessed within a certain time period for each user or API key rather than just at the request level. By tracking API resource access at the user level, you can block a user or API key once they hit a threshold such as “touched 1,000,000 items in a one hour period”. This is dependent on your API use case and can even be dependent on their subscription with you. Like a Captcha, this can slow down the speed that a hacker can exploit your API, like a Captcha if they have to create a new user account manually to create a new API key.

Insecure API key generation

Most APIs are protected by some sort of API key or JWT (JSON Web Token). This provides a natural way to track and protect your API as API security tools can detect abnormal API behavior and block access to an API key automatically. However, hackers will want to outsmart these mechanisms by generating and using a large pool of API keys from a large number of users just like a web hacker would use a large pool of IP addresses to circumvent DDoS protection.

How to secure against API key pools

The easiest way to secure against these types of attacks is by requiring a human to sign up for your service and generate API keys. Bot traffic can be prevented with things like Captcha and 2-Factor Authentication. Unless there is a legitimate business case, new users who sign up for your service should not have the ability to generate API keys programmatically. Instead, only trusted customers should have the ability to generate API keys programmatically. Go one step further and ensure any anomaly detection for abnormal behavior is done at the user and account level, not just for each API key.

Accidental key exposure

APIs are used in a way that increases the probability credentials are leaked:

  1. APIs are expected to be accessed over indefinite time periods, which increases the probability that a hacker obtains a valid API key that’s not expired. You save that API key in a server environment variable and forget about it. This is a drastic contrast to a user logging into an interactive website where the session expires after a short duration.
  2. The consumer of an API has direct access to the credentials such as when debugging via Postman or CURL. It only takes a single developer to accidently copy/pastes the CURL command containing the API key into a public forum like in GitHub Issues or Stack Overflow.
  3. API keys are usually bearer tokens without requiring any other identifying information. APIs cannot leverage things like one-time use tokens or 2-factor authentication.

If a key is exposed due to user error, one may think you as the API provider has any blame. However, security is all about reducing surface area and risk. Treat your customer data as if it’s your own and help them by adding guards that prevent accidental key exposure.

How to prevent accidental key exposure

The easiest way to prevent key exposure is by leveraging two tokens rather than one. A refresh token is stored as an environment variable and can only be used to generate short lived access tokens. Unlike the refresh token, these short lived tokens can access the resources, but are time limited such as in hours or days.

The customer will store the refresh token with other API keys. Then your SDK will generate access tokens on SDK init or when the last access token expires. If a CURL command gets pasted into a GitHub issue, then a hacker would need to use it within hours reducing the attack vector (unless it was the actual refresh token which is low probability)

Exposure to DDoS attacks

APIs open up entirely new business models where customers can access your API platform programmatically. However, this can make DDoS protection tricky. Most DDoS protection is designed to absorb and reject a large number of requests from bad actors during DDoS attacks but still need to let the good ones through. This requires fingerprinting the HTTP requests to check against what looks like bot traffic. This is much harder for API products as all traffic looks like bot traffic and is not coming from a browser where things like cookies are present.

Stopping DDoS attacks

The magical part about APIs is almost every access requires an API Key. If a request doesn’t have an API key, you can automatically reject it which is lightweight on your servers (Ensure authentication is short circuited very early before later middleware like request JSON parsing). So then how do you handle authenticated requests? The easiest is to leverage rate limit counters for each API key such as to handle X requests per minute and reject those above the threshold with a 429 HTTP response. There are a variety of algorithms to do this such as leaky bucket and fixed window counters.

Incorrect server security

APIs are no different than web servers when it comes to good server hygiene. Data can be leaked due to misconfigured SSL certificate or allowing non-HTTPS traffic. For modern applications, there is very little reason to accept non-HTTPS requests, but a customer could mistakenly issue a non HTTP request from their application or CURL exposing the API key. APIs do not have the protection of a browser so things like HSTS or redirect to HTTPS offer no protection.

How to ensure proper SSL

Test your SSL implementation over at Qualys SSL Test or similar tool. You should also block all non-HTTP requests which can be done within your load balancer. You should also remove any HTTP headers scrub any error messages that leak implementation details. If your API is used only by your own apps or can only be accessed server-side, then review Authoritative guide to Cross-Origin Resource Sharing for REST APIs

Incorrect caching headers

APIs provide access to dynamic data that’s scoped to each API key. Any caching implementation should have the ability to scope to an API key to prevent cross-pollution. Even if you don’t cache anything in your infrastructure, you could expose your customers to security holes. If a customer with a proxy server was using multiple API keys such as one for development and one for production, then they could see cross-pollinated data.

#api management #api security #api best practices #api providers #security analytics #api management policies #api access tokens #api access #api security risks #api access keys

Autumn  Blick

Autumn Blick

1601381326

Public ASX100 APIs: The Essential List

We’ve conducted some initial research into the public APIs of the ASX100 because we regularly have conversations about what others are doing with their APIs and what best practices look like. Being able to point to good local examples and explain what is happening in Australia is a key part of this conversation.

Method

The method used for this initial research was to obtain a list of the ASX100 (as of 18 September 2020). Then work through each company looking at the following:

  1. Whether the company had a public API: this was found by googling “[company name] API” and “[company name] API developer” and “[company name] developer portal”. Sometimes the company’s website was navigated or searched.
  2. Some data points about the API were noted, such as the URL of the portal/documentation and the method they used to publish the API (portal, documentation, web page).
  3. Observations were recorded that piqued the interest of the researchers (you will find these below).
  4. Other notes were made to support future research.
  5. You will find a summary of the data in the infographic below.

Data

With regards to how the APIs are shared:

#api #api-development #api-analytics #apis #api-integration #api-testing #api-security #api-gateway