You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tauri-plugins-workspace/plugins/http
github-actions[bot] 85635a2807
publish new versions (#2643)
2 weeks ago
..
guest-js feat(http): add status code 101, 103 for null body (#2655) 1 month ago
permissions chore(deps): update tauri monorepo to v2.4.1 (v2) (#2589) 2 months ago
src feat(http): persist cookies on disk (#1978) 3 months ago
CHANGELOG.md publish new versions (#2643) 2 weeks ago
Cargo.toml publish new versions (#2643) 2 weeks ago
LICENSE.spdx feat(http): add plugin (#325) 2 years ago
LICENSE_APACHE-2.0 feat(http): add plugin (#325) 2 years ago
LICENSE_MIT feat(http): add plugin (#325) 2 years ago
README.md docs(all): incorrect path for registering plugin in rust (#2123) 6 months ago
SECURITY.md chore: adjust prettier config, .gitignore and use taplo to format toml files (#1728) 9 months ago
api-iife.js feat(http): add status code 101, 103 for null body (#2655) 1 month ago
banner.png chore: add missing banners (#442) 2 years ago
build.rs fix(shell): fix schema requiring `sidecar` property even though it is optional (#1839) 8 months ago
package.json publish new versions (#2643) 2 weeks ago
rollup.config.js chore: adjust prettier config, .gitignore and use taplo to format toml files (#1728) 9 months ago
tsconfig.json feat(http): add plugin (#325) 2 years ago

README.md

plugin-http

Access the HTTP client written in Rust.

Platform Supported
Linux
Windows
macOS
Android
iOS

Install

This plugin requires a Rust version of at least 1.77.2

There are three general methods of installation that we can recommend.

  1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
  2. Pull sources directly from Github using git tags / revision hashes (most secure)
  3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)

Install the Core plugin by adding the following to your Cargo.toml file:

src-tauri/Cargo.toml

[dependencies]
tauri-plugin-http = "2.0.0"
# alternatively with Git:
tauri-plugin-http = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }

You can install the JavaScript Guest bindings using your preferred JavaScript package manager:

Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.

pnpm add @tauri-apps/plugin-http
# or
npm add @tauri-apps/plugin-http
# or
yarn add @tauri-apps/plugin-http

# alternatively with Git:
pnpm add https://github.com/tauri-apps/tauri-plugin-http#v2
# or
npm add https://github.com/tauri-apps/tauri-plugin-http#v2
# or
yarn add https://github.com/tauri-apps/tauri-plugin-http#v2

Usage

First you need to register the core plugin with Tauri:

src-tauri/src/lib.rs

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_http::init())
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

Afterwards all the plugin's APIs are available through the JavaScript guest bindings:

import { fetch } from '@tauri-apps/plugin-http'
const response = await fetch('http://localhost:3003/users/2', {
  method: 'GET',
  timeout: 30
})

Contributing

PRs accepted. Please make sure to read the Contributing Guide before making a pull request.

Partners

CrabNebula

For the complete list of sponsors please visit our website and Open Collective.

License

Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.

MIT or MIT/Apache 2.0 where applicable.