Comandos REST-API a través de Visual Studio Code y Thunder Client
1. Introducción
Esta guía muestra cómo enviar comandos HTTP a un cliente REST-API utilizando el complemento Thunder Client en Visual Studio Code.
2. Plug-in de Visual Studio Code "Thunder Client" (Cliente Trueno)
Atención:
En principio, ninguna de las acciones puede deshacerse en todo el plug-in.
Los cambios sólo son válidos después de guardar (CTRL + S).
2.1. Plug-In de instalación
Haga clic en la pestaña "Extensiones" de la parte izquierda y busque "Thunder Client".
Haga clic en el botón azul "Instalar" para instalar la extensión, que también aparecerá como una pestaña independiente en la parte izquierda.
Si la pestaña de Thunder Client no aparece, se debe al modo restringido al reiniciar:
Haga clic en el campo Modo restringido y luego confirme en "Confiar".
2.2. Utilice
- Lista de comandos recientes
- Biblioteca de comandos: Colecciones
Aquí se pueden importar o exportar comandos predefinidos en paquetes.
Atención: La versión gratuita sólo puede contener 50 comandos por colección.
- Tipo de comando: GET, POST, DELETE, etc.
- Personalización de cabeceras
Se puede añadir información adicional de cabecera al campo gratuito:
Ejemplo: Enviar cookie en la información de cabecera:
- Autenticación
Aquí se puede añadir información adicional sobre diferentes métodos de autenticación
Ex: Bearer Token
Ex: Basic Authetification
Se transmite en la cabecera en el formato usaername:password en formato Base64.
Atención: ¡no se puede utilizar para el login de usuarios!
- Información del cuerpo con diferentes formatos de datos
Envío de archivos: - Envío del comando
- Respuesta al comando
A continuación se muestra un ejemplo de la respuesta a un proceso de inicio de sesión.
1. Respuesta directa:
2. Información de cabecera
3. Cookies (separadas): Cookies (separadas):
4. Analizar solicitud:
3. Variables
Existen tres tipos de variables:
Variables de ruta: {{variable}}
Variables de entorno: {{variable}}
Variables de sistema: {{#Variable}}
Las variables de entorno pueden definirse en la pestaña Env.
Ejemplo: Inicio de sesión con variables de entorno
- Iniciar sesión y recuperar el token de portador
- Personalizar variable de entorno:
Atención: ¡No olvide guardar! - Utilice la variable en el comando POST:
Atención:
Los valores de las variables se asignan en secuencia.
Si una variable existe más de una vez (¡no hay comprobación del editor!), siempre se asigna el valor de la variable más baja,
Ejemplo: Aquí a la variable PortNumber se le asigna el valor 1.
3.1. Variables de trayectoria
Las variables de ruta se muestran entre llaves.
Se pueden asignar a un comando en la pestaña Consulta.
3.2. Variables de entorno
Las variables de entorno pueden definirse en la pestaña Env.
Ejemplo: Inicio de sesión con variables de entorno
- Iniciar sesión y recuperar el código de acceso
- Personalizar variable de entorno:
Atención: ¡No olvide guardar! - Utilice la variable en el comando POST:
Atención:
Los valores de las variables se asignan en secuencia.
Si una variable existe más de una vez (¡no hay comprobación del editor!), siempre se asigna el valor de la variable más baja,
Ejemplo: Aquí a la variable NúmeroPuerto se le asigna el valor 1.
Sólo una lista de variables puede estar activa a la vez.
Puede cambiar entre las tablas de variables en la parte inferior del entorno de desarrollo:
3.3. Variables del sistema
Las variables de sistema se muestran entre llaves dobles y también tienen un hash {{#variable}}.
Ejemplo: Configuración de la hora del sistema mediante una variable del sistema
Ejemplo: Valores generados aleatoriamente para nombres, cadenas o correos electrónicos
3.4. Automatización de procesos
Se distingue entre pre-solicitudes y solicitudes POST, que pueden enviarse automáticamente hasta cierto punto.
Los programas Javascript también pueden reproducirse antes o después.
Las pre-solicitudes son comandos y peticiones que pueden enviarse antes de que se envíe el comando real.
Ejemplo: Consultar si ha iniciado sesión. Si no, se ejecuta el inicio de sesión.
Ejemplo de scripting:
Las post-solicitudes se envían o procesan después de que se haya ejecutado el comando real.
Ejemplo: Establecimiento de variables.
Ejemplo: Comprobación de la respuesta del comando.
Ejemplo de scripting: Evaluar respuesta.
Scripting
4. Colecciones
Se pueden insertar colecciones predefinidas o archivos YAML a través de Importar.
Cada colección se puede dotar de ajustes globales que afectan a cada comando y carpeta.
Se puede especificar una ruta base en Opciones, que se coloca delante de cada comando de la colección.
BaseURL y BasePath se almacenan aquí.
Ejemplo:
192.168.1.1/api/balluff/v2
El resto del comando específico se define mediante la entrada del comando respectivo.
Si se cargan APIs externas a través de un archivo YAML, por ejemplo, es posible que haya que adaptar variables en el comando:
Como aquí, hay que insertar un {} adicional para que se reconozca como una variable de la tabla Env.
Atención: ¡Cada colección sólo puede contener 50 comandos en la versión gratuita!