Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/request-dl/request-dl-nio

Simplifies network requests using SwiftNIO with powerful types like DataTask, DownloadTask, and UploadTask.
https://github.com/request-dl/request-dl-nio

async-await certificate-pinning combine declarative linux mtls-authentication networking request swift swift-nio

Last synced: about 2 months ago
JSON representation

Simplifies network requests using SwiftNIO with powerful types like DataTask, DownloadTask, and UploadTask.

Host: GitHub
URL: https://github.com/request-dl/request-dl-nio
Owner: request-dl
License: mit
Created: 2022-09-17T12:03:10.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-01-31T23:05:06.000Z (8 months ago)
Last Synced: 2024-07-09T23:35:11.260Z (3 months ago)
Topics: async-await, certificate-pinning, combine, declarative, linux, mtls-authentication, networking, request, swift, swift-nio
Language: Swift
Homepage: https://swiftpackageindex.com/request-dl/request-dl-nio/main/documentation/requestdl
Size: 3.88 MB
Stars: 89
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

[![Swift Compatibility](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Frequest-dl%2Frequest-dl-nio%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/request-dl/request-dl-nio)
[![Platform Compatibility](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Frequest-dl%2Frequest-dl-nio%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/request-dl/request-dl-nio)
[![codecov](https://codecov.io/gh/request-dl/request-dl-nio/graph/badge.svg?token=MW5J053T85)](https://codecov.io/gh/request-dl/request-dl-nio)

# RequestDL

> Thanks to **Mike Lewis**, progress is seamlessly integrated into this library, providing a simple and streamlined experience.

RequestDL is a Swift package designed to simplify the process of performing network requests. It provides a set of tools, including the `RequestTask` protocol, which supports different types of requests, including `DataTask`, `DownloadTask`, and `UploadTask`.

One of the key features of RequestDL is its support for specifying properties of a request, such as `Query`, `Payload`, and `Headers`, among others. You can also use `RequestTaskModifier` and `RequestTaskInterceptor` to process the response after the request is complete, allowing for actions like decoding, mapping, error handling based on status codes, and logging responses in the console.

The `Property` protocol is another powerful feature that allows developers to implement custom properties to define various aspects of the request within a struct specification or using the `@PropertyBuilder`. This makes it easy to customize requests to meet specific needs.

## [Documentation](https://swiftpackageindex.com/request-dl/request-dl-nio/main/documentation/requestdl)

Check out our comprehensive documentation to get all the necessary information to start using RequestDL in your project.

### First steps

- [Creating the project property](https://swiftpackageindex.com/request-dl/request-dl-nio/main/documentation/requestdl/creating-the-project-property)
- [Preparing the certificates](https://swiftpackageindex.com/request-dl/request-dl-nio/main/documentation/requestdl/preparing-the-certificates)

### Essentials

- [Building the request](https://swiftpackageindex.com/request-dl/request-dl-nio/main/documentation/requestdl/building-the-request)
- [Executing the request](https://swiftpackageindex.com/request-dl/request-dl-nio/main/documentation/requestdl/executing-the-request)

### Translations

- [Portuguese](https://o-nnerb.github.io/request-dl-portuguese/documentation/requestdl)

We would be delighted to have your help in translating our documentation into your preferred language! Simply open a Pull Request on our repository with the link to your translated version. We are looking forward to receiving your contribution!

## Installation

RequestDL can be installed using Swift Package Manager. To include it in your project, add the following dependency to your Package.swift file:

```swift
dependencies: [
.package(url: "https://github.com/request-dl/request-dl-nio.git", from: "3.0.3")
]
```

## Usage

Using RequestDL is easy and intuitive. You can create network requests in a declarative way, specifying the properties of the request through the use of the `Property` protocol or using the `@PropertyBuilder` attribute.

Here's an example of a simple `DataTask` that queries Google for the term "apple", logs the response in the console, and ignores the HTTP's response head:

```swift
try await DataTask {
BaseURL("google.com")

HeaderGroup {
AcceptHeader(.json)
CustomHeader(name: "xxx-api-key", value: token)
}

Query(name: "q", value: "apple")
}
.logInConsole(true)
.decode(GoogleResponse.self)
.extractPayload()
.result()
```

This code creates a `DataTask` with the `BaseURL` set to "google.com", a `HeaderGroup` containing the "Accept" set to "application/json", a "xxx-api-key" header set the API token, and a query parameter with the key "q" and the value "apple". It then sets the `logInConsole` property to true, which will print the response in the console when the request is completed. It also decodes the response into an instance of `GoogleResponse` and then ignores it.

This is just a simple example of what RequestDL can do. Check out the documentation for more information on how to use it.

## Versioning

We follow semantic versioning for this project. The version number is composed of three parts: MAJOR.MINOR.PATCH.

- MAJOR version: Increments when there are incompatible changes and breaking changes. These changes may require updates to existing code and could potentially break backward compatibility.

- MINOR version: Increments when new features or enhancements are added in a backward-compatible manner. It may include improvements, additions, or modifications to existing functionality.

- The PATCH version includes bug fixes, patches, and safe modifications that address issues, bugs, or vulnerabilities without disrupting existing functionality. It may also include new features, but they must be implemented carefully to avoid breaking changes or compatibility issues.

It is recommended to review the release notes for each version to understand the specific changes and updates made in that particular release.

## Contributing

If you find a bug or have an idea for a new feature, please open an issue or submit a pull request. We welcome contributions from the community!

## Acknowledgments

This library owes a lot to the work of Carson Katri and his Swift package [Request](https://github.com/carson-katri/swift-request). Many of the core concepts and techniques used in RequestDL were inspired by Carson's library, and the original implementation of RequestDL even used a fork of Carson's library as its foundation.

Without Carson's work, this library would not exist in its current form. Thank you, Carson, for your contributions to the Swift community and for inspiring the development of RequestDL.