2.0

Author: Meterwhite

CHANGELOG.md

@@ -1,3 +1,5 @@
 ## 1.0.0
+* Initial release
 
-* TODO: Describe initial release.
+## 2.0.0
+* Updated naming conventions

README.md

@@ -8,64 +8,75 @@
     - (outLoginUser)
 
 ## Getting started
-
-
-## Usage
+#### Installing
+```yaml
+dependencies:
+  flutter_api_model: latest_version
+```
+#### Importing
 ```dart
-doAsync() async {
-    LoginAPI api = await LoginAPI(inNickname: 'jack', inPassword: '12345',).execute();
-    if (api.hasError) {
-      alert(api.outError);
-    } else {
-      User? currentUser = api.outUser;
-      if(currentUser != null) {
-        pagePush();
-      } else {
-        alert('User does not exist');
-      }
-    }
-}
+import 'package:flutter_api_model/flutter_api_model.dart';
 ```
 
+### Using `await`
 ```dart
-doSync() {
-    LoginAPI(inNickname: 'jack', inPassword: '12345').onComplete((api) {
-      if (api.hasError) {
-        alert(api.outError);
-      } else {
-        User? currentUser = api.outUser;
-        if (currentUser != null) {
-          pagePush();
-        } else {
-          alert('User does not exist');
-        }
-      }
-    }).execute();
+final model = await ProfileAPIModel(inUserId: '2024').start();
+if (model.hasError) {
+  final error = model.outError;
+} else {
+  final user = model.outUser;
 }
 ```
-### class define
+
+### Using callback
 ```dart
-class LoginAPI extends ModelAPI<LoginAPI> {
-  LoginAPI({required this.inNickname, required this.inPassword});
+ProfileAPIModel(inUserId: '2024').onComplete((model) {
+  if (!model.hasError) {
+    final user = model.outUser;
+  } else {
+    final error = model.outError;
+  }
+}).start();
 
-  String inNickname;
+```
 
-  String inPassword;
+### Class definition
+```dart
+class ProfileAPIModel extends BaseAPI with model<ProfileAPIModel>, APIWithLoginNeed {
+  ProfileAPIModel({required this.inUserId});
 
+  /// Input parameter
+  String inUserId;
+  /// Output result
   User? outUser;
 
   @override
-  loading() async {
+  load() async {
     try {
-      outUser = await httpRequestUser();
+      final response = await dio.request('/user/profile');
+      outUser = User.jsonToUser(response.data['user']);
     } catch (e) {
       outError = e;
     } finally {
-      complete();
+      finalize();
     }
   }
 }
-```
 
-## Additional information
+/// Defines a base type if initialization work is needed
+class BaseAPI {
+  Dio dio = Dio();
+
+  BaseAPI() {
+    dio.options.baseUrl = 'https://base_url.com';
+    dio.options.headers = {'token': '2024'};
+  }
+}
+
+mixin APIWithLoginNeed {
+  bool hasPermission() {
+    return isLogin();
+  }
+}
 
+```

example/example.md

@@ -8,66 +8,75 @@
     - (outLoginUser)
 
 ## Getting started
+#### Installing
+```yaml
+dependencies:
+  flutter_api_model: latest_version
+```
+#### Importing
+```dart
+import 'package:flutter_api_model/flutter_api_model.dart';
+```
 
-
-## Usage
-### await形式
+### Using `await`
 ```dart
-final requestModel = await ProfileRequestModel(inUserId: '2024').execute();
-if (requestModel.hasError) {
-    final error = requestModel.outError;
+final model = await ProfileAPIModel(inUserId: '2024').start();
+if (model.hasError) {
+  final error = model.outError;
 } else {
-    final user = requestModel.outUser;
+  final user = model.outUser;
 }
 ```
-### 回调形式
+
+### Using callback
 ```dart
-ProfileRequestModel(inUserId: '2024').onComplete((model) {
-    if (!requestModel.hasError) {
-    final user = requestModel.outUser;
-    } else {
-    final error = requestModel.outError;
-    }
-}).execute();
+ProfileAPIModel(inUserId: '2024').onComplete((model) {
+  if (!model.hasError) {
+    final user = model.outUser;
+  } else {
+    final error = model.outError;
+  }
+}).start();
+
 ```
-### Class define
+
+### Class definition
 ```dart
-class ProfileRequestModel extends BaseRequest
-    with RequestModel<ProfileRequestModel>, RquestModelWithLoginNeed {
-  ProfileRequestModel({required this.inUserId});
+class ProfileAPIModel extends BaseAPI with model<ProfileAPIModel>, APIWithLoginNeed {
+  ProfileAPIModel({required this.inUserId});
 
+  /// Input parameter
   String inUserId;
-
+  /// Output result
   User? outUser;
 
   @override
-  loading() async {
+  load() async {
     try {
       final response = await dio.request('/user/profile');
       outUser = User.jsonToUser(response.data['user']);
     } catch (e) {
       outError = e;
     } finally {
-      complete();
+      finalize();
     }
   }
 }
 
-class BaseRequest {
+/// Defines a base type if initialization work is needed
+class BaseAPI {
   Dio dio = Dio();
 
-  BaseRequest() {
+  BaseAPI() {
     dio.options.baseUrl = 'https://base_url.com';
     dio.options.headers = {'token': '2024'};
   }
 }
 
-mixin RquestModelWithLoginNeed {
+mixin APIWithLoginNeed {
   bool hasPermission() {
     return isLogin();
   }
 }
-```
-
-## Additional information
 
+```

lib/flutter_api_model.dart

@@ -0,0 +1,4 @@
+library flutter_request_model;
+
+export 'src/api_model.dart';
+export 'src/api_model_on_list.dart';