DEV Community: Milton Diaz

Entendiendo las APIs RESTful y el Protocolo HTTP

Milton Diaz — Mon, 15 Jul 2024 17:23:57 +0000

Una API (aplication programming interfaces o en español interfaces de programación de aplicaciones), es una interfaz que sirve como medio para que dos o más programas se comuniquen e interactúen entre ellos y compartan datos bajo ciertas normas y estándares.

Existen distintitos tipos de APIs

APIs de Servicios Web: Este tipo de API permite el intercambio de información entre un servidor y un cliente haciendo uso del protocolo http o https, la información será transportada comúnmente en formato JSON o XML
APIs de Bibliotecas: Este tipo de API nos permite hacer uso de funciones, métodos o rutinas que hacen parte de una biblioteca la cual tendremos que importar
APIs de Clases: Este tipo de API nos permite hacer uso de clases ya definidas las cuales ya poseen una lógica de programación con el fin de agilizar el proceso de desarrollo
APIs de Sistema operativos: este tipo de API permite que nuestros programas interactúen con el sistema operativo con el fin de tener acceso a elementos como el teclado, la interfaz gráfica, etc.

Nota: Una API puede ser local o remota

Protocolo HTTP (Hypertext Transfer Protocol)

En español protocolo de transferencia de hipertexto, es un protocolo que gestiona la conexión de los servidores web con los navegadores. Definiendo ciertas normas y estándares para poder establecer una conexión.

Los navegadores utilizan este protocolo para solicitar páginas web a un servidor, el servidor devuelve la información solicitada en código HTML para que pueda ser mostrada en el navegador.

Este método funciona de la siguiente manera.

El cliente envía una petición, que se transmite por internet
El servidor recibe y procesa la petición, genera una respuesta y la envía al cliente
Finalmente el cliente recibe la respuesta

Generalmente el cliente es el navegador, pero también puede ser otra API, un sistema de pruebas, entre otros.

Nota. Adaptada de Marisneth Reyes. Pintorest. (https://co.pinterest.com/pin/755056693770449347/).

Códigos de Estado HTTP

Estos códigos nos indican cómo está siendo procesada una solicitud. Cada estado tiene asociado un código ya definido, y cada código tiene un significado semántico que representa el estado de una petición.

Estados de Código 1xx: Estos códigos indican que la petición fue recibida por el servidor, pero está siendo procesada por el servidor
Estados de Código 2xx: Indican que la petición fue recibida, aceptada y procesada correctamente
Estados de Código 3xx: Indican que hay que tomar acciones adicionales para completar la solicitud, como por ejemplo redirecciones
Estados de Código 4xx: Indican errores del lado del cliente, es decir que se hizo mal una solicitud, faltan datos o puede estar solicitando un recurso que no existe
Estados de Código 5xx: Indican errores por parte del servidor

Códigos más Comunes

200: Indica que una petición GET fue exitosa
201: Indica que una petición POST fue exitosa
204: Indica que la solicitud se procesó correctamente pero no nos retorna información
400: Indica que la petición que estamos enviando al servidor es errónea
403: forbidden, indica que no tenemos acceso el recurso al que queremos acceder así estemos autenticados en el servidor
401: Indica que antes de hacer una petición al servidor debemos de autenticarnos con el servidor
404: Indica que el recurso al que queremos acceder no existe
500: Es un error que retorna el servidor cuando la solicitud no pudo ser procesada

REST (Representational State Transfer)

REST, por sus siglas en español (transferencia de estado representacional), es un conjunto de principios que definen la forma en la que se deben de manipular los datos.

REST le agrega una capa muy delgada de complejidad y abstracción a HTTP, mientras que http se basa en la transferencia de archivos, REST se basa en la transferencia de recursos.

El funcionamiento de REST es el siguiente:

El servidor expone la API REST y el cliente hace uso de ella
El servidor almacena la información y la pone a disposición del usuario, mientras que el cliente toma la información y la muestra al usuario

API RESTful

Un API RESTful, no es más que una API que utiliza los principios de REST para comunicarse hacia y desde un servidor, el principio fundamental de las APIs RESTFUL es el uso de los métodos o verbos HTTP.

GET: Para obtener un recurso
POST: Para crear un nuevo recurso
PUT: Para reemplazar un recurso por completo
DELETE: Para borrar un recurso
PATCH: Para modificar una parte de un recurso
HEADER: Para consultar la existencia de un recurso
OPTIONS: Para consultar si un dominio permite realizar una petición, solo funciona con peticiones que se realizan desde un navegador

Estos métodos son utilizados por el cliente para crear, manipular y eliminar datos de un servidor

Elementos de una API RESTful

Recurso: En una API RESTful, todo se considera un recurso. Un recurso es cualquier tipo de objeto, dato o servicio que puede ser accedido y manipulado a través de la API.
URI: Es una cadena de caracteres que identifica de manera única un recurso específico en la API. Ejemplo: https://api.ejemplo.com/usuarios/123.
Acción/Verbos: Todas las peticiones a una API RESTful deben estar asociadas a uno de los verbos HTTP (GET, POST, PUT, DELETE).
Endpoint: Un endpoint es el punto final de la comunicación con la API. Representa el medio a través del cual el cliente y el servidor se comunican. Cada endpoint está asociado con una URI y un método HTTP específico. Ejemplo GET https://api.ejemplo.com/usuarios/123.
Headers: Los headers en las solicitudes y respuestas HTTP transportan información adicional necesaria para la comunicación y el procesamiento de los recursos.
Solicitud y Respuesta (Request and Response): El cuerpo de la solicitud contiene los datos que se envían al servidor, mientras que el cuerpo de la respuesta contiene los datos que el servidor devuelve al cliente.
Formato: Cada recurso debe estar representado en un formato específico, como JSON, XML, PNG, entre otros. El formato define cómo se estructura y se intercambia la información entre el cliente y el servidor.

Nota. Adaptada de Hoanlk. Connecting Automation Industry With HTTP REST API: Potential And Dream Of The Future Of Technology. (https://co.pinterest.com/pin/755056693770449347/).

Solicitud y Respuesta (Request and Response)

Una petición o "request" en inglés, es una de las partes más importantes de una API REST. Es una solicitud enviada por un cliente (como un navegador web, una aplicación móvil o un programa) a un servidor para realizar una acción específica sobre un recurso. Estas peticiones utilizan los métodos HTTP para indicar la acción deseada y se dirigen a una URI que identifica el recurso.

Una petición está compuesta por la dirección de destino, el método HTTP, los encabezados y el cuerpo que contiene la información que se va a enviar al servidor.

Nota. Adaptada de Esteban Balvin. Curso API testing conPostman para crear automatizacion. 2024. (https://co.pinterest.com/pin/755056693770449347/).

Comandos Avanzados

Milton Diaz — Sat, 13 Jul 2024 22:50:34 +0000

`SYSTEMINFO`

Muestra información detallada del PC y del sistema.

systeminfo

`TASKLIST`

Muestra un listado de los programas y tareas que se están ejecutando.

tasklist

`TASKKILL -IM`

Permite cerrar un programa.

taskkill -im nombre_del_programa.exe

`CONTROL KEYBOARD`

Muestra las propiedades del teclado.

control keyboard

`DESK.CPL`

Abre las propiedades de la pantalla.

desk.cpl

`CONTROL FONTS`

Muestra las fuentes que están instaladas en el sistema.

control fonts

`CONTROL INTERNATIONAL` - `INTL.CPL`

Abren la configuración regional de fecha y hora.

// Opción 1
control international

// Opción 2
intl.cpl

`APPWIZ.CPL`

Abre el programa especificado.

appwiz.cpl programa.exe

`SYSDM.CPL`

Abre las propiedades del sistema.

sysdm.cpl

`FSMGMT.MSC`

Abre las carpetas que estén compartidas.

fsmgmt.msc

`SHUTDOWN`

Apaga el equipo.

shutdown

Comandos de Red

Milton Diaz — Sat, 13 Jul 2024 22:50:00 +0000

`IPCONFIG`

Muestra los datos esenciales de red del ordenador.

ipconfig

`IPCONFIG /ALL`

Muestra información más detallada sobre los adaptadores de red del ordenador.

ipconfig /all

`NCPA.CPL`

Muestra las conexiones de red.

ncpa.cpl

Comandos de Fecha

Milton Diaz — Sat, 13 Jul 2024 22:48:26 +0000

`DATE` (FECHA)

Este comando nos muestra la fecha actual y nos da la opción de poner una nueva fecha.

// Opción 1: sin parámetros, muestra la fecha actual y permite poner una nueva fecha
date

// Opción 2: con parámetros (/t), solo muestra la fecha actual
date /t

Nota: Para poder cambiar la fecha, es necesario acceder al símbolo del sistema como administrador.

`TIME` (HORA)

Este comando es parecido al anterior, pero solo muestra la hora actual y da la opción de cambiarla.

// Opción 1: sin parámetros, muestra la hora actual y permite cambiar la hora
time

// Opción 2: con parámetros (/t), solo muestra la hora actual
time /t

Nota: Para poder cambiar la hora, es necesario acceder al símbolo del sistema como administrador.

Comandos para Manipular Archivos y Directorios

Milton Diaz — Sat, 13 Jul 2024 22:44:51 +0000

`DIR` ‘DIRECTORY’

Permite listar el contenido de un directorio

// Opción 1
dir Documentos

// Opción 2
dir C:\Usuarios\NombreDeUsuario\Documentos

`CD` ‘CHANGE DIRECTORY’

Sirve para movernos entre directorios

Selecciona la carpeta que especificamos

// Opción 1
cd Documentos

// Opción 2
cd C:\Usuarios\NombreDeUsuario\Documentos

Nos indica en que directorio estamos

cd .

Nos lleva al directorio anterior

cd ..

Nos lleva a la unidad C:\

// Opción 1
cd \

// Opción 2
cd /

`MD` ‘MAKE DIRECTORY’

Crea un directorio

md Documentos

`MKDIR` ‘MAKE DIRECTORY’

Al igual que el comando anterior este también nos permite crear directorios

mkdir Documentos

`COPY CON`

Permite crear archivos de texto.

// Opción 1
copy con Archivo.txt

// Opción 2
copy con C:\Usuarios\NombreDeUsuario\Archivo.txt

Nota: Una vez ejecutado el comando, escribe el contenido que desees en el archivo. Para finalizar, presiona las teclas [Control] + [Z] y después [Enter].

`TYPE`

Permite visualizar el contenido de un archivo de texto.

type Archivo.txt

`DEL` - `ERASE`

Permiten eliminar archivos.

// Opción 1: eliminar el archivo especificado
del nombre_del_archivo.extension_del_archivo

// Opción 2: eliminar el archivo especificado
erase nombre_del_archivo.extension_del_archivo

// Opción 3: eliminar los archivos del directorio especificado
del nombre_del_directorio

// Opción 4: eliminar los archivos del directorio especificado
erase nombre_del_directorio

`COPY` (COPIAR)

Permite copiar un archivo.

// Opción 1: copiar un archivo en la carpeta que nos encontremos
copy archivo_que_se_va_a_copiar.extension nombre_del_nuevo_archivo.extension

// Opción 2: copiar el archivo en una carpeta diferente
copy archivo_que_se_va_a_copiar.extension ruta\nombre_del_nuevo_archivo.extension

`MOVE` (MOVER)

Permite mover un archivo a otro directorio.

move archivo.extension ruta\nombre_del_archivo.extension

`RMDIR` - `RD` (REMOVE DIRECTORY)

Permiten eliminar directorios vacíos.

// Opción 1
rmdir nombre_del_directorio

// Opción 2
rd nombre_del_directorio

Comandos Básicos

Milton Diaz — Sat, 13 Jul 2024 22:41:28 +0000

`CLS` (CLEAN SCREEN)

Permite limpiar la ventana del símbolo del sistema.

cls

`HELP`

Muestra información de ayuda del comando especificado.

// Opción 1
help comando

// Opción 2: muestra un listado de comandos con su descripción
help

`/?` (AYUDA)

Muestra información de ayuda del comando especificado.

comando /?

`ECHO`

Muestra mensajes por pantalla.

echo mensaje

`TITLE` (TÍTULO)

Permite cambiar el título de la ventana del símbolo del sistema.

title nuevo_titulo

`TREE` (ÁRBOL)

Muestra un listado de la estructura de carpetas de una unidad de disco o ruta especificada.

tree

`CONTROL + C`

Se utiliza para cancelar la ejecución de un comando y devolver el control al usuario.

`F7`

Muestra el historial de todos los comandos que hemos utilizado en una misma sesión del símbolo del sistema.

`COLOR`

Permite cambiar los colores de la ventana del símbolo del sistema.

// Opción 1: cambiar solo el color de la fuente de texto
color numero_del_color_del_texto

// Opción 2: cambiar el color del texto y el fondo de la ventana del símbolo del sistema
color numero_del_color_de_fondo numero_del_color_del_texto

Colores

0 = Negro       8 = Gris
1 = Azul        9 = Azul claro
2 = Verde       A = Verde claro
3 = Aguamarina  B = Aguamarina claro
4 = Rojo        C = Rojo claro
5 = Púrpura     D = Púrpura claro
6 = Amarillo    E = Amarillo claro
7 = Blanco      F = Blanco brillante

Nota: Si ejecutamos solo el comando color, se restablecen los colores a los valores por defecto.

Guía Completa del CMD de Windows: Desde Conceptos Básicos hasta Comandos Avanzados

Milton Diaz — Sat, 13 Jul 2024 22:35:49 +0000

La consola CMD, también conocida como símbolo del sistema es la ventana interprete de Windows que permite enviar cualquier tipo de orden al sistema operativo.

La inicia la aplicación de 16 bits cmd.exe que se encuentra la ruta C:\Windows\System32 la cual traduce e interpreta los comandos transmitidos al sistema operativo.

¿Cómo abrir el símbolo del sistema en Windows?

Presiona la tecla [Win] + [R], después de que se abra la ventana de ejecutar escribe cmd y presiona [Enter] o en Aceptar.

¿Cómo abrir el símbolo del sistema como administrador?
Presiona la tecla [Win] + [R], en la ventana de ejecutar escribe cmd, después mantén pulsadas las teclas [Conrol] + [Shift] y presiona [Enter] o en Aceptar, tendrás que aceptar la ventana de confirmación para abrir el símbolo del sistema como administrador.

Te invito a explorar los siguientes artículos, donde explico desde los comandos más básicos hasta los más avanzados del CMD de Windows. En estos artículos, encontrarás una guía completa que te permitirá mejorar tu productividad y solucionar problemas comunes de manera eficiente.

DEV Community: Milton Diaz

Entendiendo las APIs RESTful y el Protocolo HTTP

Protocolo HTTP (Hypertext Transfer Protocol)

Códigos de Estado HTTP

Códigos más Comunes

REST (Representational State Transfer)

API RESTful

Elementos de una API RESTful

Solicitud y Respuesta (Request and Response)

Comandos Avanzados

SYSTEMINFO

TASKLIST

TASKKILL -IM

CONTROL KEYBOARD

DESK.CPL

CONTROL FONTS

CONTROL INTERNATIONAL - INTL.CPL

APPWIZ.CPL

SYSDM.CPL

FSMGMT.MSC

SHUTDOWN

Comandos de Red

IPCONFIG

IPCONFIG /ALL

NCPA.CPL

Comandos de Fecha

DATE (FECHA)

TIME (HORA)

Comandos para Manipular Archivos y Directorios

DIR ‘DIRECTORY’

CD ‘CHANGE DIRECTORY’

MD ‘MAKE DIRECTORY’

MKDIR ‘MAKE DIRECTORY’

COPY CON

TYPE

DEL - ERASE

COPY (COPIAR)

MOVE (MOVER)

RMDIR - RD (REMOVE DIRECTORY)