Explore las pruebas de API compatibles con código

¿Cómo pruebo mi API?

Antes de aprender sobre las pruebas de API, solía crear una API completando la ruta y los parámetros, y luego enviaba una solicitud para verificar los resultados. Como control de calidad, escribiría un informe de prueba. Sin embargo, dado que cada API es independiente, tuve que inicializar el entorno de prueba cada vez antes de comenzar una nueva prueba.

Con las pruebas de API usando herramientas como Apitgit, solo necesito proporcionar un código simple, que genera el informe de prueba automáticamente. Además, podemos guardar la respuesta y usarla en otra solicitud para probar la lógica real del sistema. Esto ahorra tiempo y esfuerzo en el proceso de prueba.

Iniciar una prueba de API

Para iniciar la prueba de la API, vaya a laTest Cases sección en su repositorio y haga clic en el+ botón. Rellene elpath name con una cuerda comomyfirsttest/getUser. En este ejemplo,myfirstname es el nombre de la carpeta, ygetUser es el nombre del caso de prueba. Si está agregando otro caso de prueba, puede elegir la carpeta que desee sin tener que volver a ingresar el nombre de la carpeta. Si bien en el ejemplo ponemos varios casos de prueba en un archivo, puede hacerlo más simple organizando cada caso de prueba en un archivo separado.

Cree una carpeta de prueba de API y un archivo de caso de prueba

La estructura de un archivo de prueba

Código de muestra en el archivo "myfirsttest/addPet".

[
    {
        "type": "code",
        "description": "initialization",
        "parameters": {
            "code": "var baseUrl = env.get(\"baseUrl\");\nif (baseUrl == null) {\n    state.baseUrl = \"http://petstore.mock.apigit.com\";\n    //env.set(\"baseUrl\", \"http://petstore.mock.apigit.com\")\n}"
        }
    },
  {
    "type": "http",
    "description": "place an order for a pet",
    "parameters": {
      "method": "post",
      "url": "{baseUrl}/store/order",
      "query": [],
      "auth": {
        "type": "none"
      },
      "header": [
        {
          "name": "content-type",
          "value": "application/json",
          "enabled": true
        }
      ],
      "body": {
        "type": "application/json",
        "data": "{\n  \"id\": 11,\n  \"petId\": 198772,\n  \"quantity\": 7,\n  \"shipDate\": \"2023-01-14T19:25:54.211Z\",\n  \"status\": \"approved\",\n  \"complete\": true\n}"
      },
      "postTest": "if (!res || res.status !== 200) {\n    failed(\"place purchae order failed\")\n    return;\n}\n\nvar order = res.data;\nstate.orderId = order.id;"
    }
  }
]

Este es un diseño increíble. El código está estructurado en formato JSON. Es una matriz JSON que contiene varios objetos JSON. En términos de ingeniería de software, esta estructura se asemeja a una función. El nombre del archivo del caso de prueba representa el nombre de la función y cada objeto JSON representa una línea de código ejecutable. El archivo se compila de la siguiente manera:

exports.addPet = function () {
    //first JSON object
    var baseUrl = env.get("baseUrl");if (baseUrl == null) {state.baseUrl = "http://petstore.mock.apigit.com";}
    //second JSON object
    var res = post(body);if (!res || res.status !== 200) {failed("place purchae order failed");return;}var order = res.data;state.orderId = order.id;
};

Para más información, puede visitar[Documento de prueba de API][]. Es una herramienta de prueba increíble que se puede usar no solo para probar API con servidores simulados, sino también para probar servidores reales.