Flutter WordPress客户端插件wordpress_client的使用

🚀 Features

• 📦 API discovery support.
• ⏲️ Measures request completion time.
• 📝 Supports all CRUD operations.
• 🌐 Supports all common endpoints.
• 🎨 Custom Requests & Authorization systems.
• 🔐 3 Popular authorization methods.
• 📦 Third party Database integration.
• 🔧 Middlewares for request & response operations.
• 🎣 Events for preprocessing response.
• 🚀 Execute requests in Parallel.

Future

If you find any functionality missing, please share the details on GitHub Discussions.

📦 Installation

Add wordpress_client to your pubspec.yaml:

dependencies:
  wordpress_client: ^8.5.3

Then run flutter pub get to install the package.

🔧 Usage

Import the Package

import 'package:wordpress_client/wordpress_client.dart';

Initialization

You can initialize WordpressClient using two methods:

Simple Method

final baseUrl = Uri.parse('https://example.com/wp-json/wp/v2');
final client = WordpressClient(baseUrl: baseUrl);

For advanced initialization, refer to the Advanced Method.

Sending Requests

Example to retrieve 20 recent WordPress posts in ascending order:

final request = ListPostRequest(
  page: 1,
  perPage: 20,
  order: Order.asc,
);

final response = await client.posts.list(request);

// Dart 3 style
switch (response) {
  case WordpressSuccessResponse():
    final data = response.data; // List<Post>
    break;
  case WordpressFailureResponse():
    final error = response.error; // WordpressError
    break;
}

// Using map method to handle both success and failure
final result = response.map(
  onSuccess: (response) {
    print(response.message);
    return response.data;
  },
  onFailure: (response) {
    print(response.error.toString());
    return <Post>[];
  },
);

// You can cast to a state directly; this will throw an error if the response is of the wrong type
final result = response.asSuccess(); // or response.asFailure();

Refer to the documentation for more request examples.

🔒 Supported Authorization

AppPasswordAuth

By the WordPress Team, uses basic HTTP authentication where credentials are passed with every request. Details

BasicJwtAuth

Developed by Enrique Chavez, involves JSON Web Token (JWT) authentication where a token is issued and then used in subsequent requests. Details

UsefulJwtAuth

By Useful Team, another implementation using JWT for authentication purposes. Details

For custom authorization, check the Authorization Wiki.

📋 Supported REST Methods

📢 Custom Response Types

Learn how to implement Custom Requests here.

🤝 Feedback & Contributing

• For bugs or feature requests, use the issue tracker.
• Contributions are always appreciated. PRs are welcome!

📄 License

This project is MIT licensed.

示例代码

// ignore_for_file: avoid_print, unused_local_variable

import 'package:wordpress_client/wordpress_client.dart';

import 'auth_middleware.dart';

Future<void> main() async {
  final baseUrl = Uri.parse('https://example.com/wp-json/wp/v2');

  // Simple Usage
  final client = WordpressClient(
    baseUrl: baseUrl,
    bootstrapper: (bootstrapper) => bootstrapper
        .withDebugMode(true)
        .withMiddleware(AuthMiddleware())
        .withMiddleware(
          DelegatedMiddleware(
            onRequestDelegate: (request) async {
              return request.copyWith(
                headers: {
                  'X-My-Custom-Header': 'My Custom Value',
                },
              );
            },
            onResponseDelegate: (response) async {
              return response;
            },
          ),
        )
        .build(),
  );

  final response = await client.posts.list(
    ListPostRequest(
      perPage: 1,
      order: Order.asc,
    ),
  );

  response.map<void>(
    onSuccess: (response) {
      print('Posts Count: ${response.data.length}');
      // prints Posts Count: 1, as expected
    },
    onFailure: (response) {
      print(response.error);
    },
  );
}