HTTP Client

GitHub npm crates.io

API Reference

Make HTTP requests with the http plugin.

Setup

Install the http plugin to get started.

Automatic

Use your project’s package manager to add the dependency:

npm

npm run tauri add http

Yarn

yarn run tauri add http

pnpm

pnpm tauri add http

Cargo

cargo tauri add http

Manual

1. Run cargo add tauri-plugin-http to add the plugin to the project’s dependencies in Cargo.toml.

2. Modify lib.rs to initialize the plugin:

   lib.rs

   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   pub fn run() {
       tauri::Builder::default()
           // Initialize the plugin
           .plugin(tauri_plugin_http::init())
           .run(tauri::generate_context!())
           .expect("error while running tauri application");
   }

3. If you’d like to make http requests in JavaScript then install the npm package as well:

   npm

   npm install @tauri-apps/plugin-http

   Yarn

   yarn add @tauri-apps/plugin-http

   pnpm

   pnpm add @tauri-apps/plugin-http

Usage

The http plugin is available in both as an JavaScript API and in Rust as a reqwest re-export.

JavaScript

1. Configure the allowed URLs

   src-tauri/capabilities/base.json

   {
     "permissions": [
       {
         "identifier": "http:default",
         "allow": [{ "url": "https://*.tauri.app" }],
         "deny": [{ "url": "https://private.tauri.app" }]
       }
     ]
   }

   For more information, please see the documentation for Access Control Lists

2. Send a request

   import { fetch } from '@tauri-apps/plugin-http';
   
   // Send a GET request
   const response = await fetch('http://test.tauri.app/data.json', {
     method: 'GET',
   });
   console.log(response.status); // e.g. 200
   console.log(response.statusText); // e.g. "OK"

   Note

   The current fetch method is an API to Rust backend. It tries to be as close and compliant to the fetch Web API as possible.

Rust

In Rust you can utilize the reqwest crate re-exported by the plugin. For more details refer to reqwest docs.

use tauri_plugin_http::reqwest;

let res = reqwest::get("http://my.api.host/data.json").await;
println!("{:?}", res.status()); // e.g. 200
println!("{:?}", res.text().await); // e.g Ok("{ Content }")