搜尋套件、儲存庫與 APP 分類

套件詳情v2.0.0

gql_dio_link

類似於 gql_http_link,gql_dio_link 是一個 GQL 終止連結,使用 Dio 透過 JSON 執行請求。

AndroidiOSWebmacOSWindowsLinux
近 30 天下載
2.8萬
喜歡數
34
Pub 分數
160

安裝套件

flutter pub add gql_dio_link

套件介紹

根據套件公開資料產生的選型評估,僅供參考。

gql_dio_link 是一個用於 Dart 的 GraphQL 終止連結,可使用 Dio(一個強大的 HTTP 客戶端)執行 GraphQL 請求。它與 gql-dart 生態系統無縫整合,利用 Dio 的強大功能,如攔截器、請求/回應轉換和錯誤處理。專為高效基於 JSON 的通訊設計,支援所有主要平台,包括行動裝置、網頁和桌面端。適用於需要在 GraphQL 工作流程中靈活控制 HTTP 和進階網路功能的應用程式。

適用情境

  • 將 GraphQL 與自訂 HTTP 結合邏輯
  • 使用 Dio 的攔截器進行驗證
  • 處理複雜的請求/回應轉換
  • 使用共享網絡邏輯構建跨平台應用
  • 透過 Dio 實現重試機制
  • 自定標頭和超時

主要特色

  • 基於 Dio 建構,用於進階 HTTP 控制
  • 支援基於 JSON 的 GraphQL 執行
  • 提供中間件的攔截器
  • 跨平台相容性
  • 與 gql-dart 的輕鬆整合
  • 可設定的請求/回應處理

適合對象

  • 在專案中使用 Dio 的開發者
  • 需要細粒度 HTTP 控制的應用
  • 建構可擴展 GraphQL 客戶端的團隊
  • 需要跨平台網路功能的專案
  • 希望使用 HTTP 中間件擴展 GraphQL 行為的使用者

使用建議

  • 需要熟悉 Dio
  • 額外依賴開銷
  • 可能需要手動設定以進行進階設定
  • 不太適合簡單的HTTP用例
  • 僅限JSON傳輸
  • 依賴於 gql-dart 生態系統的穩定性

原始 README

以下為關聯原始碼儲存庫的 README 原文快照,最新內容請造訪原始碼儲存庫。

gql-dart/gql

MIT License PRs Welcome Watch on GitHub Star on GitHub Watch on GitHub Discord

This is an effort to advance the Dart GraphQL ecosystem.

It consists of multiple packages and libraries centered around GraphQL AST.

Packages

Core

The core of this project is the GraphQL parser which parses GraphQL strings into an AST. The parsed AST can then be transformed, visited and printed back to GraphQL string.

Pub Package Library Description
version package:gql ast.dart GraphQL AST implementation with Visitor pattern and AST transformer
version package:gql language.dart GraphQL source parser and printer. Recognizes both operations and SDL
version package:gql document.dart Document and schema validation
Code generation

GraphQL language enables code generation to speed up development and move document processing to build-time.

We provide code builders to generate Dart source code and file builders which easily plug into standard Dart code generation pipeline.

Ideas for future work:

  • Typed resolvers for field resolution on the client or server
Pub Package Library Description
version package:gql_code_builder Various builders
version package:gql_build File builders
Client

To enable development of GraphQL clients, we provide type definitions used to execute GraphQL operations. They include AST-based operation, request with per operation context, and response. These types are used by the Links.

Link is the current client implementation. Link is GraphQL AST-aware request/response middleware. They can be used to build a pipeline to deduplicate requests, conditionally transform requests and responses (including the context), and eventually send the requests to the server.

Ideas for future work:

  • websocket link for subscriptions
  • batched request HTTP link
  • retry link to handle network issues transparently
  • link for client-side request resolution
Pub Package Library Description
version package:gql_exec gql_exec.dart Implementation of types for GraphQL requests and responses
version package:gql_link link.dart Base for modular GraphQL execution interface
version package:gql_http_link gql_http_link.dart Link to execute GraphQL requests via HTTP
version package:gql_dedupe_link gql_dedupe_link.dart De-duplicating Link to avoid execution of identical requests
version package:gql_transform_link gql_transform_link.dart GQL Link to transform Requests and Responses. May be used to update context, document, variables, data, errors, etc.
version package:gql_websocket_link gql_websocket_link.dart GQL Link for subscriptions using websocket.
version package:gql_dio_link gql_dio_link.dart Similar to gql_http_link, A GQL Terminating Link to execute requests via Dio using JSON.
Other
Pub Package Library Description
version package:gql_pedantic Lint rules used by all gql-dart/gql packages
Examples
Pub Package Library Description
version package:gql_example_cli Example usage in a CLI environment
version package:gql_example_flutter Example usage in a Flutter environment

Users

Project Description
artemis Build dart types from GraphQL schemas and queries (using Introspection Query).
graphql A stand-alone GraphQL client for Dart, bringing all the features from a modern GraphQL client to one easy to use package.
graphql_flutter A GraphQL client for Flutter, bringing all the features from a modern GraphQL client to one easy to use package.
normalize Normalization and denormalization of GraphQL responses in Dart
ferry GraphQL Client for Dart
Your project? Open a PR to add it to this readme!

Contributing

The goal of this project is to expand Dart GraphQL ecosystem and to build a community around this vendor-neutral implementation.

Community contributions are welcome.

Release Process

This repository uses Melos to manage the monorepo and handle releases. The release process is partially automated through GitHub Actions.

Repository Structure

The repository is organized into several package categories:

  • Core packages:

    • gql: Core GraphQL package
    • gql_tristate_value
    • gql_code_builder_serializers
    • gql_code_builder
  • Execution packages:

    • gql_exec
    • gql_link
  • Link implementations:

    • gql_http_link
    • gql_dio_link
    • gql_websocket_link
    • gql_dedupe_link
    • gql_error_link
    • gql_transform_link
  • Build packages:

    • gql_build

Local Development

To get started with local development:

  1. Install Melos:

    dart pub global activate melos && dart pub get
    
  2. Bootstrap the workspace:

    melos bootstrap
    
  3. Run tests:

    melos test
    

Release Process

Automated Publishing

The publish workflow is automated via GitHub Actions and triggers when:

  • Changes are pushed to the master or release branches AND include changes to any pubspec.yaml file
  • Manually triggered through GitHub Actions UI

The automated process:

  1. Validates all packages (formatting, analysis, and tests)
  2. Publishes packages in dependency order:
    • Core packages first
    • Execution packages second
    • Link implementation packages third
    • Build packages last
Manual Release Steps

To create a new release manually:

  1. Ensure you're on the branch you want to release from (master or release)

  2. Version the packages using one of the following commands:

    # For a patch release
    melos run bump-patch
    
    # For a minor release
    melos run bump-minor
    
    # For a major release
    melos run bump-major
    
    # For an alpha release
    melos run bump-alpha
    
    # To graduate from prerelease(alpha) to stable
    melos run graduate
    
  3. Push the changes and tags:

    git push && git push --tags
    
  4. The GitHub Action will automatically handle publishing to pub.dev if changes include pubspec.yaml files

Versioning Rules
  • Use bump-patch for backward-compatible bug fixes
  • Use bump-minor for backward-compatible features
  • Use bump-major for breaking changes
  • Use bump-alpha for prerelease versions
  • Use graduate to promote prerelease versions to stable

Available Melos Commands

  • melos bootstrap: Set up the workspace
  • melos clean: Clean all packages
  • melos test: Run tests for all packages
  • melos format: Format all packages
  • melos analyze: Run static analysis
  • melos build: Run build_runner for all packages
  • melos publish: Publish packages to pub.dev

Troubleshooting

If the automated publish fails:

  1. Check the GitHub Actions logs for specific errors
  2. Ensure all tests are passing locally: melos test
  3. Verify that version numbers in pubspec.yaml files are correct
  4. Check that all dependencies are properly versioned

For manual publishing (if needed, requires pub dev authentication):

melos publish --no-dry-run --yes --scope="package_name"

Notes

  • The publish workflow publishes packages in a specific order to handle dependencies correctly
  • All packages are versioned together to maintain consistency
  • The workflow automatically handles pub.dev credentials through GitHub Secrets
  • Changes to pubspec.yaml files automatically trigger the publish workflow

Features and bugs

Please file feature requests and bugs at the GitHub.

所屬分類

依賴

依賴清單 5 項

原始碼儲存庫

使用此套件的專案