HTTP 客户端

GitHub npm crates.io

API Reference

使用 http 插件触发 HTTP 请求。

🌐 Make HTTP requests with the http plugin.

支持的平台

🌐 Supported Platforms

This plugin requires a Rust version of at least 1.77.2

Platform	Level	Notes
windows
linux
macos
android
ios

设置

🌐 Setup

安装 http 插件即可开始使用。

🌐 Install the http plugin to get started.

Automatic

使用项目的包管理器添加依赖：

npm

npm run tauri add http

yarn

yarn run tauri add http

pnpm

pnpm tauri add http

deno

deno task tauri add http

bun

bun tauri add http

cargo

cargo tauri add http

Manual

1. 在 src-tauri 文件夹中运行以下命令，将插件添加到 Cargo.toml 中的项目依赖：

   cargo add tauri-plugin-http

2. 修改 lib.rs 以初始化插件：

   src-tauri/src/lib.rs

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

3. 如果你想在 JavaScript 中进行 http 请求，那么也安装这个 npm 包：

   npm

   npm install @tauri-apps/plugin-http

   yarn

   yarn add @tauri-apps/plugin-http

   pnpm

   pnpm add @tauri-apps/plugin-http

   deno

   deno add npm:@tauri-apps/plugin-http

   bun

   bun add @tauri-apps/plugin-http

使用

🌐 Usage

HTTP 插件在 Rust 中作为 reqwest 的重新导出以及在 JavaScript 中可用。

🌐 The HTTP plugin is available in both Rust as a reqwest re-export and JavaScript.

JavaScript

1. 配置允许的 URL

   src-tauri/capabilities/default.json

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

   欲了解更多信息，请参阅权限概览的文档

2. 发送请求

   fetch 方法尽可能接近并遵循 fetch Web API。

   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

   默认情况下，[禁止的请求头] 会被忽略。要使用它们，你必须启用 unsafe-headers 功能标志：

   src-tauri/Cargo.toml

   [dependencies]
   tauri-plugin-http = { version = "2", features = ["unsafe-headers"] }

Rust

在 Rust 中，你可以使用插件重新导出的 reqwest crate。更多详情请参考 reqwest 文档。

🌐 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 }")

Default Permission

This permission set configures what kind of fetch operations are available from the http plugin.

This enables all fetch operations but does not allow explicitly any origins to be fetched. This needs to be manually configured before usage.

Granted Permissions

All fetch operations are enabled.

This default permission set includes the following:

• allow-fetch
• allow-fetch-cancel
• allow-fetch-send
• allow-fetch-read-body
• allow-fetch-cancel-body

Permission Table

Identifier	Description
http:allow-fetch	Enables the fetch command without any pre-configured scope.
http:deny-fetch	Denies the fetch command without any pre-configured scope.
http:allow-fetch-cancel	Enables the fetch_cancel command without any pre-configured scope.
http:deny-fetch-cancel	Denies the fetch_cancel command without any pre-configured scope.
http:allow-fetch-cancel-body	Enables the fetch_cancel_body command without any pre-configured scope.
http:deny-fetch-cancel-body	Denies the fetch_cancel_body command without any pre-configured scope.
http:allow-fetch-read-body	Enables the fetch_read_body command without any pre-configured scope.
http:deny-fetch-read-body	Denies the fetch_read_body command without any pre-configured scope.
http:allow-fetch-send	Enables the fetch_send command without any pre-configured scope.
http:deny-fetch-send	Denies the fetch_send command without any pre-configured scope.