Logo
PepposCoderhouseAPITests API Documentation

Español

Estructura de colecciones

  • Para entender el armado de collections y folders internos referirse a la planilla de casos de prueba, enlace aqui

Colecciones

  • Cada llamada de API cuenta con test script definidos
  • Se definen variables globales para ciertos test scripts se realice la verificación. De manera que solo se deba cambiar una vez por ejemplo el texto a obtener para todos los ambientes.
  • Se intenta describir valores en las llamadas en la sección query params
  • Cabe destacar que cada llamada realizada cuenta con un nombre descriptivo

Ambientes @ Environments

  • Se definen 5 ambientes
  • Ambientes didácticos para demostrar conocimiento (no son funcionales/operativo, a excepción de producción que funciona efectivamente)
  • En cada ambiente se almacena la variable peppos_url la cual cambia segun el ambiente
  • Al realizar esta acción en una situación real de proyecto con distintos ambientes donde solo cambia la url principal es de gran ayuda
  • En las llamadas se coloca {{peppos_url}} asi indicando que utiliza el valor del ambiente seleccionado

URLs de ambientes

  • Ambiente LOCAL -> URL ficticia -> http:localhost:3001
  • Ambiente DEV -> URL ficticia -> https://dev.peppos.com.uy
  • Ambiente QA -> URL ficticia -> https://qa.peppos.com.uy
  • Ambiente UAT -> URL ficticia -> https://uat.peppos.com.uy
  • Ambiente PRODUCCION -> URL real -> https://www.peppos.com.uy

Creación de Monitor

  • Se crea monitor
  • Monitor creado actualmente pausado
  • Monitor seteado originalmente para correr cada domingo 2 am, ejecutar en ambiente de producción, notificar a casilla de mail, no reintentar en caso de fallar


Para realizar la descripción se utilizo de referencia MarkDownGuide


#####################################################################################################################################################################

English

Collections structure

  • To understand how collections and folders are assembled based on test case creation sheet, link here

Collections

  • Every API call has its own test script/s defined
  • Global variables are defined for certain test scripts in order to do assertions. So in case there's any text or value expected to be modified, would be mofified only once cause' would be valid for any environment
  • In every API call values are described as most possible at query params section
  • Every API call has a descriptive name

Environments

  • 5 environments are defined
  • Production environment is to function, the rest is fictional to demonstrate knowledge on settings up environment's variables.
  • Every environment has a varialbe called "peppos_url" which lets to define environment's former url
  • This is implemented based on a real case scenario which demands tester to test api methods/calls within different environments in a quick, simple and trusted way.
  • API Calls URL will displayed {{peppos_url}} which points to environment's former URL

Environments' URLs

  • LOCAL -> Fictional environment's URL-> http:localhost:3001
  • DEV -> Fictional environment's URL -> https://dev.peppos.com.uy
  • QA -> Fictional environment's URL -> https://qa.peppos.com.uy
  • UAT -> Fictional environment's URL -> https://uat.peppos.com.uy
  • PRODUCCION (PRODUCTION) -> URL -> https://www.peppos.com.uy

Monitors

  • A monitor is created
  • Monitor currently paused
  • Monitor's actual settings: Execute every sunday at 2 AM, execute in production, notify to email recipient defined, if fails don't retry


To realize this description was employed guide MarkDownGuide

ENDPOINTS