httpRequest | Doc Detective

Referenced In

Fields

Field	Type	Description	Default
httpRequest	one of: - string - object(HTTP request (detailed))	Required. Perform a generic HTTP request, for example to an API.	—

Examples

{
  "httpRequest": "https://reqres.in/api/users"
}

{
  "httpRequest": {
    "url": "https://reqres.in/api/users"
  }
}

{
  "httpRequest": {
    "url": "https://reqres.in/api/users/2",
    "method": "put",
    "request": {
      "body": {
        "name": "morpheus",
        "job": "zion resident"
      }
    }
  }
}

{
  "httpRequest": {
    "url": "https://reqres.in/api/users",
    "method": "post",
    "request": {
      "body": {
        "name": "morpheus",
        "job": "leader"
      }
    },
    "response": {
      "body": {
        "name": "morpheus",
        "job": "leader"
      }
    },
    "statusCodes": [
      200,
      201
    ]
  }
}

{
  "httpRequest": {
    "url": "https://www.api-server.com",
    "method": "post",
    "timeout": 30000,
    "request": {
      "body": {
        "field": "value"
      },
      "headers": {
        "header": "value"
      },
      "parameters": {
        "param": "value"
      }
    },
    "response": {
      "body": {
        "field": "value"
      },
      "headers": {
        "header": "value"
      }
    },
    "statusCodes": [
      200
    ]
  }
}

{
  "httpRequest": {
    "url": "https://reqres.in/api/users",
    "method": "post",
    "request": {
      "body": {
        "name": "morpheus",
        "job": "leader"
      }
    },
    "response": {
      "body": {
        "name": "morpheus",
        "job": "leader"
      }
    },
    "statusCodes": [
      200,
      201
    ],
    "path": "response.json",
    "directory": "media",
    "maxVariation": 0.05,
    "overwrite": "aboveVariation"
  }
}

{
  "httpRequest": {
    "openApi": "getUserById"
  }
}

{
  "httpRequest": {
    "openApi": {
      "name": "Reqres",
      "operationId": "getUserById"
    },
    "request": {
      "parameters": {
        "id": 123
      }
    }
  }
}

{
  "httpRequest": {
    "openApi": {
      "descriptionPath": "https://api.example.com/openapi.json",
      "operationId": "getUserById"
    },
    "request": {
      "parameters": {
        "id": 123
      }
    }
  }
}

{
  "httpRequest": {
    "openApi": {
      "descriptionPath": "https://api.example.com/openapi.json",
      "operationId": "createUser",
      "useExample": "both"
    }
  }
}

{
  "httpRequest": {
    "openApi": {
      "descriptionPath": "https://api.example.com/openapi.json",
      "operationId": "updateUser",
      "useExample": "request",
      "exampleKey": "acme"
    }
  }
}

{
  "httpRequest": {
    "openApi": {
      "descriptionPath": "https://api.example.com/openapi.json",
      "operationId": "updateUser",
      "useExample": "request",
      "exampleKey": "acme",
      "headers": {
        "Authorization": "Bearer $TOKEN"
      }
    }
  }
}

{
  "httpRequest": {
    "url": "https://www.api-server.com",
    "method": "post",
    "request": {
      "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
    }
  }
}

{
  "httpRequest": {
    "url": "https://api.example.com/users/123",
    "response": {
      "required": [
        "id",
        "email",
        "createdAt"
      ]
    }
  }
}

{
  "httpRequest": {
    "url": "https://api.example.com/users/123",
    "response": {
      "required": [
        "user.profile.name",
        "user.profile.avatar",
        "user.settings.notifications"
      ]
    }
  }
}

{
  "httpRequest": {
    "url": "https://api.example.com/orders",
    "response": {
      "required": [
        "orders[0].id",
        "orders[0].total",
        "orders[0].items[0].productId"
      ]
    }
  }
}

{
  "httpRequest": {
    "url": "https://api.example.com/users",
    "response": {
      "required": [
        "sessionToken",
        "expiresAt",
        "user.id"
      ],
      "body": {
        "status": "success",
        "user": {
          "role": "admin"
        }
      }
    }
  }
}