REST Web API

Por -
La tecnología del desarrollo de sistemas informáticos varía y evoluciona a una velocidad impresionante. De la programación estructurada, la programación visual a los conceptos actuales de servicios web, API (Application Programming Interface) y REST (Representational State Transfer). Actualmente en aplicaciones o sitios web hoy, lo más común es hablar de REST y .NET Web API. A menos que estés usando esas tecnologías si están en el ámbito de la informática. La mejor forma de entender las cosas es usarlas en forma práctica.

En un esquema de integración de aplicación tradicional cada aplicación cliente tiene su propia lógica de negocios (probablemente programada en varios leguajes diferentes) que se conecta directamente a la base de datos para obtener, actualizar y manipular datos.

Esta lógica de negocios local significa que las aplicaciones del cliente pueden volverse complejas fácilmente y todas deben mantenerse sincronizadas entre sí. Cuando se requiera una nueva característica, deberá actualizar cada aplicación en consecuencia. Este puede ser un proceso muy costoso que a menudo conduce a la fragmentación de las características, errores y realmente puede retrasar la innovación.

Ahora analicemos la misma arquitectura con una API centralizada que contiene toda la lógica de negocio.

La Arquitectura REST modera sigue el concepto de Don’t Repeat Yourself’ (DRY)  No repetir el proceso' (DRY) de desarrollo de software. Las aplicaciones se convierten en capas de interfaz de usuario relativamente livianas. REST es un patrón arquitectónico para crear una API que usa HTTP como su método de comunicación subyacente.

REST fue originalmente concebido por Roy Fielding en su trabajo de disertación de 2000 titulado 'Estilos arquitectónicos y el diseño de arquitecturas de software basadas en red', les recomiendo ver ese artículo en el siguiente link:

Casi todos los dispositivos que están conectados a Internet ya usan HTTP; es el protocolo base sobre el que se basa Internet, y por eso es una gran plataforma para una API.

HTTP es un sistema de solicitud y respuesta; un cliente llamante envía una solicitud a un punto final y el punto final responde. El cliente y el punto final pueden ser cualquier cosa menos un ejemplo típico es un navegador que accede a un servidor web o a una aplicación que accede y API.

Hay varios detalles clave de implementación con HTTP que debe tener en cuenta:

Recursos: REST usa recursos direccionables para definir la estructura de la API.
Un identificador de recursos uniforme (URI) es o bien un localizador uniforme de recursos (URL), como también un nombre de recurso uniforme (URN), o ambos a la vez.

Estas son las URL que usa para llegar a las páginas en la web,
por ejemplo 'http://www.microsoft.com/Surface-Pro-3' es un recurso.
Acciones de solicitud: describen lo que quiere hacer con el recurso.
Un navegador típicamente emite un
  • GET para obtener un recurso del servidor
  • POST para crear un recurso del servidor, envía datos a una URL para que el recurso en esa URI los maneje.
  • PUT para actualizar un recurso del servidor, pone un recurso en la dirección especificada en la URL. Exactamente en esa dirección. Si no existe, lo crea, si existe lo reemplaza.
  • DELETE para eliminar un recurso del servidor

En el contexto de una API REST, los recursos normalmente representan entidades de datos (es decir, 'Paciente', 'Profesional', 'Orden', etc.). El verbo que se envía con la solicitud informa a la API qué hacer con el recurso, por ejemplo, una solicitud GET obtiene datos sobre una entidad, las solicitudes POST crean una nueva entidad.

Existe una convención que establece que las solicitudes GET a una url de la entidad, como Pacientes, devuelve una lista de Pacientes , posiblemente coincida con algunos criterios que se enviaron con la solicitud. Sin embargo, para recuperar un Paiente específico, usaría la identificación del Paciente como parte del recurso.
Por ejemplo
/ Paciente / 81 devolvería el Paciente con la ID de 81.

También es posible usar parámetros de cadena de consulta con una API, por ejemplo puede tener algo como / Paciente? Sexo= Femenino que devuelve todos los Pacientes femeninos.

La Web API utiliza los conceptos de Controlador y Acción de MVC ( Model View Controller) , por lo que si ya entiende .net MVC, se encuentra en un buen lugar. Si no lo hace, entonces la API web es una excelente forma de aprender MVC.

Los recursos se asignan directamente a los controladores; normalmente tendría un controlador diferente para cada una de sus entidades de datos principales (Paciente, Profesional, Orden, etc.).

La API web usa el motor de enrutamiento .net para asignar direcciones URL a los controladores. Normalmente, las API se mantienen dentro de una ruta '/ api /' que ayuda a distinguir los controladores API de otras API que no pertenecen al mismo sitio web.


Las acciones se utilizan para mapear verbos HTTP específicos, por ejemplo, normalmente tendrías una acción GET que devuelve todas las entidades.

Web API es parte de 'One ASP.net'
Web API es parte de la familia 'One ASP.net', lo que significa que admite de forma nativa todas las excelentes funciones compartidas que puede usar actualmente con MVC o formularios web, esto incluye (estos son solo algunos ejemplos):
  • Entity Framework, (Marco de la entidad).
  • Authorisation and identity, (Autorización e identidad).
  • Scaffolding, (Andamiaje).
  • Routing, (Enrutamiento).
El uso de una API hará que la arquitectura de su aplicación sea mucho más limpia, lo que facilitará la adición de características y la corrección de errores a medida que avance su proyecto.

REST es un patrón arquitectónico que se basa en HTTP y utiliza solicitudes HTTP, respuestas, verbos y códigos de estado para comunicarse. El hecho de que los servicios REST usen HTTP significa que pueden ser consumidos por casi cualquier dispositivo o aplicación "en línea" (incluidos dispositivos IoT como tostadoras, automóviles, podómetros, etc.). No se requiere conocimiento propietario de la API.

Web API en .net es la forma en que escribes los servicios de API REST en .NET. Web API le ofrece todos los beneficios del .NET Framework y se ocupa de muchas de las complejidades de la negociación de contenido, el enlace de modelos, etc. que tendría que tratar usted mismo sin Web API.


Comentarios

Publicar un comentario

Entradas más populares de este blog

ESCANEO DEL CODIGO PDF417 DEL DNI (Documento Nacional de Identidad digital)

Por -
Imagen
   PARSEO DEL CODIGO PDF417 DEL DNI  A partir de una lectora de codigo de barras 2D podemos leer y extraer los datos de un DNI para incorporarlos en nuestra base de datos sin necesidad de tipear los mismos en el teclado. El código incluido en el frente de la credencial, es del tipo PDF417 e incluye los siguientes campos separados por un carácter @: Número de Tramite Apellidos (ambos separados por un espacio) Nombres (ambos separados por un espacio) Sexo (M / F) Número de DNI Ejemplar Fecha Nacimiento (DD/MM/AAAA) Fecha de Emisión del documento (DD/MM/AAAA) Inicio y fin de CUIL (3 caracteres, los 2 que van antes del primer guión y el último que va luego del segundo guión)  Esperamos que esta información les sea de utilidad y cualquier consulta si esta a nuestro alcance con gusto les responderemos. Sin duda que escanear el DNI y poder extraer los datos  de apellido, nombre, sexo, número de documento y fecha de nacimiento sin tipearlos en el teclado tiene ventajas ...
Leer más

¿Que tipos de Mensajes de HL7 hay?

Por -
Imagen
Los tipos de mensajes HL7 más comúnmente utilizados incluyen: ACK - Acuse de recibo general. (General acknowledgement) ADT - Admitir, Descargar, Tranfser. (Admit, Discharge, Tranfser) BAR - Agregar / cambiar cuenta de facturación. (Add/change billing account) DFT - Transacción financiera detallada. (Detailed financial transaction) MDM - Gestión de documentos médicos. (Medical document management) MFN - Notificación de archivos maestros.(Master files notification) ORM - Orden (Farmacia / tratamiento para solicitar algo, pedido de laboratorio) ORU - Resultado de observación (para ver los resultados de estudios) La estructura general de un mensaje HL7 contiene varios segmentos (datos) que (normalmente) están orientados al paciente y se activan en función de eventos específicos (admisiones, resultados de laboratorio, procedimientos, alta, etc.) y comunican información relevante sobre ese evento desencadenado. La estructura de un mensaje HL7 se ve de la siguiente mane...
Leer más

Apex SQL una herramienta free útil para interpretar mejor el código SQL

Por -
Imagen
Hay pocas guías de formatos relacionadas a formatear SQL y estilos de código, pero no hay un estándar universalmente aceptado para SQL Server. En este artículo, sin embargo, seguiremos las guías implícitas de: MSDN Documentación de Libros en Pantalla de SQL Server 2012 Y la base de datos Adventure Works 2012 SQL Server Veremos cómo podemos implementar estos estándares vía ApexSQL Refactor. ApexSQL Refactor  es un complemento gratis para SQL Server Management Studio and Visual Studio add-in and  SQL Server Management Studio y Visual Studio y un formateador  wSQL con cerca de 200 opciones de formato. Use el terminador de sentencias Estándar:  Documentación de Libros en Pantalla de SQL Server 2012. SQL Server requiere el punto y coma sólo en casos particulares: Para terminar la sentencia previa a una cláusula WITH definiendo una Expresión de Tabla Común (CTE, por sus siglas en inglés) Para terminar la sentencia previa a una sentencia de servicio SE...
Leer más