dio README

The project's README from github.com/cfug/dio. As one markdown file: README.md.

dio

Language: English | 简体中文

This is the base repo of the dio project. Please move to specific paths for project instructions.

Don't forget to add #dio topic to your published dio-related packages! See more: https://dart.dev/tools/pub/pubspec#topics

Versioning

Before you upgrade: Breaking changes might happen in major and minor versions of packages.
See the Migration Guide for the complete breaking changes list.

To know about our compatibility policy, see the Compatibility Policy doc.

All Packages

dio

Plugins

Examples

The project and its underlying projects are originally authored by @wendux with the organization @flutterchina, started being maintained by Chinese Flutter User Group (@cfug) since 2023.

The project consents the MIT license.

dio (cfug/dio)

Searching Database…

12.8K ·GitHub
What is this?dio is a powerful open-source HTTP client for Dart and Flutter, with around 12.8k GitHub stars. This repo is its base monorepo, holding the core package, its plugins and example apps.
Is it an app I install, or a library I add to my code?It is a library: you add the dio package as a dependency of your Dart or Flutter project, not a standalone program. The repo also publishes companion plugins and runnable example apps.
How do I add it to my project?Add dio as a pub dependency — 'flutter pub add dio' in Flutter, 'dart pub add dio' in plain Dart. The core package lives in the dio/ path of this monorepo, with example/ and exampleflutterapp/ demos alongside.
Can upgrading dio in a minor release break my code?Possibly — the maintainers warn that breaking changes can happen even in minor versions, so read the Migration Guide and the Compatibility Policy doc before each upgrade.
Does it work in plain Dart, or do I need Flutter?Both: dio targets Dart and Flutter alike, with adapter plugins for different runtimes — a web adapter for browsers, a native Dio adapter for platform HTTP stacks, and an HTTP/2 adapter.
What can dio do out of the box?Global request settings, interceptors, FormData, aborting and canceling requests, file uploads and downloads, request timeouts, and custom adapters, among other features.
Which companion packages ship in this repo?Plugins for cookie management, a compatibility layer, HTTP/2, a native Dio adapter and a web adapter, plus two example apps (example and exampleflutterapp).
Is dio still actively developed?Yes — the repo runs CI workflows for tests, coverage and publishing plus CodeQL security analysis, and the project has gathered around 12.8k stars since 2018.
Creator
cfug
Size
5.1 MB
Stars
12.8K
Age
8y
Commits · 90 Days