Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carllosnc/hty
Tiny HTTP Wrapper
https://github.com/carllosnc/hty
dart http
Last synced: 11 days ago
JSON representation
Tiny HTTP Wrapper
- Host: GitHub
- URL: https://github.com/carllosnc/hty
- Owner: carllosnc
- License: mit
- Created: 2023-10-20T02:09:54.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-06-16T23:34:38.000Z (5 months ago)
- Last Synced: 2024-06-17T00:33:03.268Z (5 months ago)
- Topics: dart, http
- Language: Dart
- Homepage:
- Size: 35.2 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
# Hty
>Tiny http wrapper
[](https://github.com/carllosnc/hty/actions/workflows/dart.yml)
[](https://app.codacy.com/gh/carllosnc/hty/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
## Install
```yaml
dependencies:
hty:
git:
url: https://github.com/carllosnc/hty.git
```
Example:
```dart
import 'package:hty/hty.dart';
import 'package:http/http.dart' as http;
void main(){
var hty = Hty(
baseurl: 'https://jsonplaceholder.typicode.com',
client: http.Client(),
defaultHeaders: {
'Accept': 'application/json',
},
);
var result = await hty.get(
path: "/todos",
);
hty.close();
}
```
## Hty()
`hty` is a class that provides a set of methods for sending HTTP requests and handling responses.
```dart
var hty = Hty(
baseurl: 'https://jsonplaceholder.typicode.com',
client: http.Client(),
defaultHeaders: {
'Accept': 'application/json',
},
);
```
| Parameter | Type | Description |
| ---------------- | --------------------- | ------------------------------------------ |
| `baseurl` | `String` | Base URL for requests |
| `client` | `http.Client` | HTTP Client |
| `defaultHeaders` | `Map` | Headers that will be used on every request |
## hty.get()
`hty.get` is a method that sends a GET request to the specified path.
```dart
var reponse = await hty.get(
path: "/todos",
);
```
| Parameter | Type | Description |
| --------- | ----------------------- | ------------------------------------ |
| `path` | `String` | Path to resource |
| `query` | `Map?` | Query params |
| `headers` | `Map?` | Specific headers for current request |
| `cache` | `bool` | Memory cache, default is `true` |
> [!NOTE]
> Memory cache: If the same request is made twice, the second request will be returned from memory.
## hty.post()
`hty.post` is a method that sends a POST request to the specified path.
```dart
var reponse = await hty.post(
path: "/todos",
payload: {
'title': 'todo title',
'content': 'todo content',
},
);
```
| Parameter | Type | Description |
| ---------- | ----------------------- | ------------------------------------ |
| `path` | `String` | Path to resource |
| `headers` | `Map?` | Specific headers for current request |
| `payload` | `Map?` | Request body |
| `encoding` | `Enconding` | Default is `utf-8` |
## hty.put()
`hty.put` is a method that sends a PUT request to the specified path.
```dart
var reponse = await hty.put(
path: "/todos/1",
payload: {
'title': 'todo title',
'content': 'todo content',
},
);
```
| Parameter | Type | Description |
| ---------- | ----------------------- | ------------------------------------ |
| `path` | `String` | Path to resource |
| `headers` | `Map?` | Specific headers for current request |
| `payload` | `Map?` | Request body |
| `encoding` | `Enconding` | Default is `utf-8` |
## hty.delete()
`hty.delete` is a method that sends a DELETE request to the specified path.
```dart
var reponse = await hty.delete(
path: "/todos/1",
);
```
## HtyGetResponse
`htyGetResponse` is a class that contains the response from a GET request.
| Parameter | Type | Description |
| ----------------- | ---------------------- | ------------------------------ |
| `statusCode` | `int` | HTTP status code |
| `responseHeaders` | `Map?` | Response headers |
| `requestHeaders` | `Map?` | Request headers |
| `data` | `dynamic` | Request data |
| `response` | `http.Response` | Full response from HTTP object |
| `message` | `String` | HTTP message |
## HtyPostResponse
`htyPostResponse` is a class that contains the response from a POST request.
| Parameter | Type | Description |
| ----------------- | ---------------------- | ------------------------------ |
| `statusCode` | `int` | HTTP status code |
| `responseHeaders` | `Map?` | Response headers |
| `requestHeaders` | `Map?` | Request headers |
| `data` | `dynamic` | Request data |
| `response` | `http.Response` | Full response from HTTP object |
| `message` | `String` | HTTP message |
| `payload` | `Map?` | Request body |
## HtyException
`htyException` is a class that contains information about an error that occurred during a request.
```dart
try {
await hty.post(
path: '/posts',
payload: {
'title': 'title',
'body': 'content',
'userId': '1',
},
);
} on HtyException catch (e) {
print(e.message);
print(e.statusCode);
print(e.description);
}
```
| Parameter | Type | Description |
| ------------- | --------------------------------- | --------------------- |
| `statusCode` | `int` | HTTP status code |
| `message` | `String` | Error message |
| `description` | `Map` or `String` | Api error description |
## Development
**Start server:**
the web server run with dart frog: https://dartfrog.vgv.dev/
```bash
cd server
dart_frog serve
```
**Run tests:**
```bash
dart test
```
---
Carlos Costa @ 2023