API web 1

Introduction

Al usar la web para ejecutar mi app, significa que cualquiera tiene acceso a ella usando un browser o software que se comunique con HTTP.

Node Js cuenta con un modulo HTTP, el cual me permite como manejar solicitudes de lectura, escritura y trabajar con los datos obtenidos. Este modulo es confiable y capaz pero no están rápido como un Framework, para lo cual en esta ocasión para lograr que sea mas rápido, usaremos Express.

Create a new Express web application

Al momento de crear una aplicación web es importante tomar en cuenta los siguientes aspectos.

Routing: Esto se refiere a que mi app, se divide en  secciones en función de partes de la dirección URL.

Supporting different content types: Soporta diferente formatos, como texto sin formato, JSON, HTML, CSV, etc.

Authentication/Authorization: ,Muchas veces el acceso a la información va a depender del rol que dicho usuario va a realizar por ende la visualización de la información dependerá de ello.

Reading/Writing data: Cuando los usuarios ingresar información en formularios o carguen archivos.

Time to market:  los frameworks elegidos deben proporcionar soluciones a errores, para ahorrarle tiempo al desarrollador.

HTTP module in Node.js

http.Server: Es la representación de una instancia de HTTP Server, el cual necesita instrucciones para escuchar en determinado puerto y dirección.

http.IncomingMessage: Es un stream legible creado por http.Server o http.ClientRequest, el usuario puede acceder a  status, headers,y data.

http.ServerResponse: Stream creado por HTTP Server, el cual define como debería ser la respuesta.

Aspectos que debes tomar en cuenta para realizar una aplicación web.

Creación del servidor: El método llamado createServer() crea una instancia de http.Server.

Implementacion de  callback: Este metodo createServer() espera una callback al invocarse, y lo proporciona  http.IncomingMessageand http.ServerResponse, conocidos como res y req.

• The client request: El  req nos muestra que datos ha enviados el cliente como petición.
• The server response: El servidor guía al res dando que datos son los que va a devolver como respuesta.

Escuchar las solicitudes o requests: A través de  createServer() puedo invocar a el método  listen(), especificado el puerto esta listo para aceptar las solicitudes.

Ahora  la forma en como estos datos se transportan de un lado a otro por los streams, es decir fragmento por fragmento.

Si quieres saber mas sobre streams puedes visitar el siguiente link:

https://developersanddreamers.blogspot.com/p/node-js-2.html

 hora todo esto es ideal para aplicaciones pequeñas pero si es algo mayúsculo, que hago?, recuerdan la implementacion de frameworks, es exactamente eso, y por ello usaremos EXPRESS.

Pero por que razones elegirla por la siguientes:

• Maravillosas características(rápido y productivo).
• Extrae la complejidad(streams).
• Resuelve problemas web comunes(administración de rutas/cache/redirección/etc).
• Usada por 6.8 millones lo cual la hace confiable

Route management in Express

Cuando el cliente envía una solicitud , lo hace por medio de una URL, apuntando a una dirección y esta a un servidor

Ahora lo que puedas realizar dentro d edicha ruta dependera de cual de los verbos HTTP hayas usado POST, PUT, GET. Express nos ayuda con el registro y emparejamiento de estas rutas. Ahora nosotros vamos a querer que el cliente pueda realizar varias acciones como leer o escribir datos y lo deberás hacer así.Teniendo muy en cuenta la diferenciación de los verbos.

Express viene con batteries included lo cual me permite la admisión de varios formatos para ser devueltos al cliente, usando el método send() para archivos de texto plano, ahora con json(). Pero usando el modulo http el resultado seria así:

Create an Express application

Al momento de iniciar un proyecto en Node Js es recomendable instalar las dependencias que vamos a usar, para que cuando lo subamos a Git, alguien que quiera usar dicho código no tenga problemas con ello ya que las dependencias necesarios constaran en el package.json.

Pasos :

1. Instancia la aplicación

2. Definir rutas y manejadores de rutas

3. Configurar los middleware

4. Inicia la aplicación.

Route Management

Para facilitar el mantenimiento la app, se divide en varias estructuras, una manera d ehacerlo es haciendo uso de las URL, las cuales me va a dirigir a los diferentes recursos del la app.

URL: Es la dirección que el usuario pondrá en el browser para hallar un recurso en especifico. 

Una URL se compone de las siguientes partes:

scheme: esta parte indica el protocolo utilizado, en este caso, el esquema es http. Otro ejemplo de un esquema es https, ftp, irc, y fileentre otros.

authority: Esta seccion consta de dos partes:

User info: consta de una username@passwordparte opcional y también una hostparte. En el ejemplo anterior, has localhost siendo la parte anfitriona. localhost apunta a su propia máquina como el servidor web. En la Web, la parte de host es por lo general los nombres de dominio en especifico que usted desee.

Host : Se usa para especificar por medio de un nombre en lugar de una dirección IP. Una dirección IP son las direcciones web reales y se parecen a una serie de números 127.0.0.1. Esto facilita a los llamados route requests de una parte de la Web a la otra.Pero para las personas esto no es amigable por lo cual se opta por poner nombre a los dominios.

path: Consta de 0 a muchos segmentos, separados por un /. 

query: Esta parte es opcional y se incluye después del carácter ?. Consiste en una serie de pares de parámetros de valor de consulta delimitados por &o ;. Puede usarse para definir aun mas los parámetros de búsqueda o a su vez para indicar el tamaño de los datos.

fragment: Un fragmento me ayuda a especificar como me muestra los datos es decir en un determinado orden.

Routes: Es una subseccion de la URL que disecciona a un recurso en especifico, ahora también es importante entender los siguientes conceptos de rutas:

route parameters: El parámetro de la ruta es la parte que se usa para identificar al elemento del recurso ejemplo: /clientes/280

Nos ayuda a poder definir rutas y así asociarles a controladores y el patrón de ruta expresa seria así:

 

     

query parameters: Los parámetros de consulta se usan para determinar el tamaño de la respuesta y se los encuentra al final de la ruta ejemplo: /products?sort=desc

Los parámetros de consulta se envían en un objeto query.

        

 

Read and Write: Para ler y escribir datos, debemos configurar de manera diferente según el formato de los datos, ejemplo si los datos provienen de un Html, o en un json, las dos contarían  con configuraciones diferentes.

Sin importar el formato se debe primero importar la biblioteca body-parse, que ya viene con express, ahora para analizar los datos así:

Por otro lado para el manejo de la solicitud se lo puede hacer por post() y put(),Ahora post() se usa para expresar que desea crear un recurso, y put() para transmitir que un recurso debe actualizarse utilizando los datos entrantes.

HTTP Verbs: El verbo GET para leer datos, y POST para escribir datos.

 La organización por recursos y por operaciones como lectura / escritura se conoce como CRUD o C reate, R ead, U pdate, D elete, en español crear, leer, actualizar, borrar.

Ejemplo real de uso de Express, y elaboracion de  API.

en nuestro archivo app.js le especificamos de donde va a tomar la información y como lo va hacer.

Porción de código de  controls.js aquí especificamos que va a ejecutarse en la ruta, ejemplo crear una persona con su rol.

Nosotros usamos controles por lo cual en el index.js de rutas queda así

Manage request lifecycle with middleware

Cuando se hace una solisitud , esta debe ser verificada para comprobar si se tiene acceso al recurso solicitado. Y se lo vera de la siguiente manera.

Pre request: Se debe verificar si las credenciales de acceso enviadas por  header, coinciden.

Construct the response: Implica la comunicación con la base de datos, de la cual se obtendrán los datos de vamos a devolver, siempre y cuando la solicitud sea correcta.

Post request: Mostramos la respuestas, o a su vez podría existir un paso adicional el cual podría ser para algún registro. 

Para usar una solicitud previo o posterior debe usar use(), y tiene la siguiente estructura, a esto es lo que conocemos como middleware:

req: Es la solicitud que ingresa, por header, o body si es que envía datos el usuario.

res: Es el flujo de respuesta que usara para enviar los datos.

next: Este parámetro indica si la solicitud esta lista para ser procesada, pero sino ocurriese aquello se debe comunicar al usuario de la siguiente manera res.send('<specify a reason why the request is stopped>')

 Ejemplo del uso de use() 

A request pipeline

Cuando necesitemos ejecutar el middleware antes o después de la solicitud, para hacerlo después de la solicitud es así:

Ahora si desea hacerlo antes se debe hacer así:

Vídeo explicativo