Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carllosnc/gty
A easy way to perform GET http request in Flutter
https://github.com/carllosnc/gty
flutter http
Last synced: 11 days ago
JSON representation
A easy way to perform GET http request in Flutter
- Host: GitHub
- URL: https://github.com/carllosnc/gty
- Owner: carllosnc
- License: other
- Created: 2024-06-09T02:16:42.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-07-31T19:45:36.000Z (4 months ago)
- Last Synced: 2024-08-22T22:43:10.341Z (3 months ago)
- Topics: flutter, http
- Language: Dart
- Homepage:
- Size: 93.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# gty
[](https://github.com/carllosnc/gty/actions/workflows/dart.yml)
[](https://app.codacy.com/gh/carllosnc/gty/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
> A easy way to perform GET http request in Flutter
## Installation
Add this to your package's pubspec.yaml file:
```yaml
gty:
git:
url: https://github.com/carllosnc/gty.git
```
## Using gty Mixin
The gty mixin is designed for Flutter's StatefulWidget to streamline HTTP GET requests and manage the loading, success, and error states. It provides a easy way to handle API interactions with built-in state management.
**Features**:
- [x] State Management — Automatically handles isLoading, isSuccess, and isError states during API requests.
- [x] Response Handling — Parses JSON responses and provides easy access to transform the response data.
- [x] Custom Headers — Allows for custom headers.
- [x] Error Handling — Catches and manages errors gracefully.
- [ ] Cachable — Support for memory cache
**States**:
- `isLoading`: Indicates that a request is in progress.
- `isSuccess`: Indicates that the request completed successfully.
- `isError`: Indicates that an error occurred during the request.
- `response`: Holds the full HTTP response from the request.
- `error`: Contains the error information if the request fails.
- `data`: Provides access to the parsed JSON response data.
- `viewData`: Provides a customized view of the response data, ex: adapting the data to a specific model.
- `customLoading`: Allows for custom loading states.
**fetchData({url, headers, onSuccess})**:
- `url (required)`: The URL to which the HTTP GET request is sent.
- `headers (optional)`: Additional headers to include in the request.
- `onSuccess (optional)`: A callback function that is executed if the request is successful. This function receives the parsed JSON data as an argument and can be used to process the data.
**A complete example**:
```dart
import 'package:flutter/material.dart';
import 'package:gty/gty.dart';
import '../models/user.dart';
class ExampleOne extends StatefulWidget {
const ExampleOne({super.key});
@override
State createState() => _ExampleOneState();
}
class _ExampleOneState extends State with gty {
@override
void initState() {
super.initState();
fetchData(
url: "http://localhost:8080/users/1",
onSuccess: (data) => adapt(data, User.fromJson),
);
}
@override
Widget build(BuildContext context) {
if (isLoading) {
return const Center(
child: Text("Loading..."),
);
}
if (isError) {
return const Center(
child: Text("Error"),
);
}
return Center(
child: Text((viewData as User).name),
);
}
}
```
**Infer type of viewData**
Using the example above, the `viewData` can be inferred as a `User` object.
```dart
class _ExampleOneState extends State with gty {
...
}
```
## adapt and adaptList
The `adapt` and `adaptList` functions are used to convert JSON data to a specific model class.
**`adapt(dynamic data, Function(Map) T.fromJson) : T`**
```dart
adapt(data, User.fromJson)
```
**`adaptList(List data, Function(Map) T.fromJson) : List`**
```dart
adaptList(data, User.fromJson)
```
## Using Gty Widget
The `Gty` widget is a custom `StatefulWidget` designed to simplify making HTTP GET requests and handling different states such as loading, success, and error. It utilizes the gty mixin to manage the request lifecycle and provide a flexible way to render UI based on the request's state.
| Parameter | Type | Description |
| ------------ | ------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
| `url` | `String?` | The URL to send the HTTP GET request to. |
| `child` | `Widget Function(BuildContext context, dynamic data)` | A function that returns a widget, given the BuildContext and fetched data. |
| `error` | `Widget Function(BuildContext context, GtyException error)?` | A function that returns a widget, given the BuildContext and an error. |
| `loading` | `Widget` | A widget to display while the data is being fetched. Defaults to `Text('Loading...')`. |
| `onSuccess` | `Function(dynamic)?` | A callback function that is called when the request is successful. |
| `httpClient` | `http.Client?` | An optional custom HTTP client. |
**Usage**:
```dart
import 'package:flutter/material.dart';
import 'package:gty/gty.dart';
import '../models/user.dart';
class ExampleWidget extends StatelessWidget {
const ExampleWidget({super.key});
@override
Widget build(BuildContext context) {
return Gty(
url: "http://localhost:8080/users/1",
loading: const Text("Loading..."),
error: (context, error) => Center(
child: Text(error.message),
),
onSuccess: (data) => adapt(data, User.fromJson),
child: (context, data) {
return Text(
"${(data as User).name} - From example widget",
);
},
);
}
}
```
## Development
**Server**
The web server is provide by [dart_frog](https://pub.dev/packages/dart_frog).
```bash
cd server
dart_frog dev
```
**Tests**
```bash
flutter test
```
---
Carlos Costa @ 2024