Rutas y datos falsos

Una ruta es un método y una ruta de URL, y lo que responde el mock en ella. Crea rutas a mano cuando todavía no hay especificación, cuando necesitas unos pocos endpoints para desarrollar o probar contra ellos, o para responder a una ruta de forma distinta a la especificación. Los cuerpos se escriben tal como se envían, en JSON, XML o texto, y pueden contener datos falsos que se crean de nuevo en cada solicitud.

Las rutas creadas a mano responden después de las rutas en JavaScript del mock y antes de las operaciones de su especificación, si sirve una. Consulta qué respuesta recibe una solicitud.

Crear una rutaCopy Anchor Link

En la página Mocks, crea un mock con Nuevo mock (empieza con una ruta GET /users de cinco usuarios falsos) o abre cualquier mock. La tarjeta Rutas lista sus rutas:

• La casilla desactiva una ruta sin eliminarla; una ruta desactivada no responde a nada.
• Haz clic en una ruta para editarla debajo de la lista.
• Añadir ruta añade una nueva después de la ruta seleccionada.
• Haz clic con el botón derecho en una ruta para ver Duplicar, Crear solicitud, Copiar dirección (mientras el mock está en marcha), Subir, Bajar y Eliminar ruta.

Cada cambio se guarda al instante, y un mock en marcha responde con él al instante. Editar › Deshacer revierte cualquier cambio, también el de eliminar una ruta. Cuando dos rutas activadas tienen el mismo método y la misma ruta, la tarjeta te avisa: solo responde la primera.

Método, ruta y resumenCopy Anchor Link

• Ruta: el método (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS, o ANY para todos los métodos) y la ruta. Una solicitud HEAD va a una ruta GET, sin el cuerpo.
• Los parámetros de ruta se escriben {id} o :id, uno por cada parte de la ruta: /users/{id}, /files/{name}.json. :id se guarda como {id}. Una ruta con una parte literal tiene preferencia sobre otra con un parámetro, así que /users/me responde antes que /users/{id}.
• El Resumen dice para qué sirve la ruta. Las solicitudes creadas a partir de la ruta lo toman como nombre.

RespuestasCopy Anchor Link

Una ruta tiene una o varias respuestas. Los chips bajo RESPUESTAS cambian entre ellas; + añade una. Cada respuesta tiene:

La respuesta con una marca de verificación (Predeterminado) es la predeterminada de la ruta; Hacer predeterminada en otra la cambia. El botón de la papelera elimina una respuesta.

Elegir una respuestaCopy Anchor Link

Una solicitud a una ruta recibe, en este orden:

1. La respuesta que pide: una cabecera Prefer: example=Not found o Prefer: code=404, o las cabeceras x-mock-response-name y x-mock-response-code de Postman.
2. La primera respuesta cuyas reglas se cumplen todas.
3. La respuesta predeterminada de la ruta: la que has marcado como predeterminada con Hacer predeterminada, sean cuales sean sus reglas. En una ruta donde no has elegido ninguna, una primera respuesta cuyas reglas no se cumplieron cede el paso a la primera respuesta sin reglas, de modo que “409 para el pedido enviado”, si figura la primera en la lista, no responde a todos los demás pedidos.

Una regla mira una parte de la solicitud:

El valor es el texto que debe tener esa parte. * significa cualquier valor, siempre que haya uno; un valor vacío significa que esa parte debe faltar. Una respuesta con varias reglas solo responde cuando se cumplen todas. Una regla sin nombre se omite hasta que le pongas uno.

Por ejemplo, una ruta GET /users/{id} puede responder 200 con un usuario de forma predeterminada, y una respuesta 404 con la regla Parámetro de ruta id es 0:

curl -i http://127.0.0.1:4010/users/42    # 200, the user
curl -i http://127.0.0.1:4010/users/0     # 404

Cuerpos con datos falsosCopy Anchor Link

Todo lo que haya entre {{ }} en un cuerpo o en el valor de una cabecera se rellena cuando llega la solicitud, así que cada solicitud puede recibir datos nuevos. El resto del cuerpo se envía tal como lo escribiste.

{
  "id": "{{request.params.id}}",
  "name": "{{$randomFullName}}",
  "email": "{{$randomEmail}}",
  "company": "{{$randomCompanyName}}",
  "joined": "{{$randomDatePast}}"
}

Valores falsosCopy Anchor Link

{{$randomFirstName}}, {{$randomEmail}}, {{$randomCity}}, {{$randomPrice}}, {{$randomUUID}} y unos 120 más: nombres y profesiones, internet, direcciones, teléfonos, empresas, finanzas, productos, fechas, palabras, lorem ipsum, archivos, imágenes y bases de datos. Los nombres son las variables dinámicas de Postman, así que las plantillas escritas para Postman funcionan aquí. Algunos admiten argumentos: {{$randomInt(1, 100)}}, {{$randomPrice(5, 50)}}, {{$randomLoremWords(5)}}, {{$randomElement(active, paused, closed)}}. Los valores dinámicos los listan todos.

Insertar valor, encima del cuerpo, pone un valor falso donde está el cursor: Datos falsos los tiene por grupos.

Los mismos valores funcionan en las solicitudes, donde se crean en cada envío. Consulta valores dinámicos.

Partes de la solicitudCopy Anchor Link

Insertar valor › Solicitud los tiene, con los parámetros de ruta de la propia ruta.

ListasCopy Anchor Link

{{#repeat 10}} … {{/repeat}} escribe lo que hay entre ambos tantas veces como se indica; {{#repeat 2 8}}, un número de veces entre los dos valores, elegido en cada solicitud. En un cuerpo JSON, las comas entre los elementos se ponen por ti. Dentro, {{@number}} es el número del elemento desde 1 y {{@index}} desde 0. Las repeticiones pueden ir dentro de otras repeticiones.

[
  {{#repeat 5}}
  {
    "id": {{@number}},
    "name": "{{$randomProductName}}",
    "price": {{$randomPrice}}
  }
  {{/repeat}}
]

Un {{#repeat}} o un {{/repeat}} solo en su línea no deja ninguna línea vacía.

EscapadoCopy Anchor Link

Los valores se escapan según dónde caen, así que un nombre con comillas nunca rompe tu JSON:

• En un cuerpo JSON (un Content-Type con json), los valores dentro de una cadena se escapan como JSON. Un valor fuera de comillas, como {{$randomInt}} o {{@number}}, entra tal cual.
• En XML y HTML (un Content-Type con xml o html), &, <, > y las comillas se escapan en todas partes.
• Las llaves triples nunca escapan: {{{request.body}}} pone el cuerpo JSON de la solicitud como JSON.

{ "received": {{{request.body}}}, "at": "{{$isoTimestamp}}" }

Los tokens que Echolot no conoce se quedan como los escribiste. Un valor que no puede crear, como {{$randomInt(9, 1)}}, también se queda como está escrito, y el registro dice por qué. Un cuerpo se corta a los 16 MB y una repetición a los 10 000 elementos.

Los cuerpos no leen nada más: ni variables, ni entornos, ni secretos, ni archivos del espacio de trabajo, así que un mock que responde en la red no puede revelar ninguno de ellos.

Datos fijos: GenerarCopy Anchor Link

Los valores entre {{ }} dan datos nuevos en cada solicitud. Para responder siempre con los mismos datos, haz clic en Generar…, encima del cuerpo:

• Con Crear una lista: el cuerpo es un elemento, el cuerpo pasa a ser una lista JSON con tantos Elementos, cada uno creado a partir del cuerpo.
• Sin ella, los valores del cuerpo se rellenan una sola vez.

Generar sustituye el cuerpo por el resultado; Editar › Deshacer recupera la plantilla. Desde Terminal, echolot fake hace lo mismo.

Solicitudes a partir de rutasCopy Anchor Link

Crear solicitudes en la tarjeta Rutas crea una carpeta con el nombre del mock y una solicitud por cada ruta activada; Crear solicitud en el menú contextual de una ruta crea una para esa ruta. Echolot abre la primera solicitud.

• La carpeta tiene una variable baseUrl con la dirección del mock, y todas las URL empiezan con ella: {{baseUrl}}/users/{{id}}. Apunta baseUrl a la API real más adelante y las mismas solicitudes irán allí.
• Los parámetros de ruta se convierten en variables de la solicitud, con 1 salvo que una regla de ruta de la respuesta predeterminada indique un valor.
• La solicitud lleva el nombre del resumen de la ruta.
• El cuerpo de solicitud de la ruta va con ella.

El cuerpo de solicitud de una rutaCopy Anchor Link

Cuerpo de la solicitud, al pie de una ruta, contiene un cuerpo y su Content-Type para las solicitudes creadas a partir de la ruta, como el JSON que admite un POST /users. No cambia lo que responde el mock; las reglas sobre campos del cuerpo leen lo que las solicitudes envían de verdad.

Con agentesCopy Anchor Link

Con el conjunto de herramientas Mocks activado, los agentes y el Asistente también crean rutas. Pide lo que necesites:

• “Crea un mock con rutas para listar, leer y crear pedidos, con datos falsos, e inícialo.”
• “Añade un 404 a GET /users/{id} cuando el id sea 0.”
• “Crea solicitudes para las rutas del mock.”

Usan create_mock (con un nombre y rutas, sin necesidad de especificación), save_mock_route, delete_mock_route, generate_fake_data, list_fake_values y create_requests_from_mock. save_mock_route también puede convertir una respuesta del Historial en una ruta; lo que copia se enmascara como todo lo que leen los agentes. Cuando un agente elimina una ruta, te pregunta antes. Consulta Agentes.

En el espacio de trabajoCopy Anchor Link

Las rutas viven en el archivo del mock, mocks/<name>.toml, como [[routes]] con sus [[routes.responses]]: legibles en un diff y compartidas mediante Git. Consulta archivos del espacio de trabajo.