Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/IBM-Swift/Kitura-net

Kitura networking
https://github.com/IBM-Swift/Kitura-net

fastcgi headers http kitura networking request response socket swift

Last synced: 3 months ago
JSON representation

Kitura networking

Awesome Lists containing this project

README

        



Kitura



APIDoc


Build Status - Master

macOS
Linux
Apache 2

Slack Status

# Kitura-Net

The Kitura-net module contains logic for sending and receiving HTTP requests. It also contains the structure for listening on a port and sending requests to a delegate for processing. It can be used to create HTTP/CGI servers on specific ports, and provides HTTP functionality.

We expect most of our users to require higher level concepts such as routing, templates and middleware, these are not provided in Kitura-net, if you want to use those facilities you should be coding at the Kitura level, for this please see the [Kitura](https://github.com/Kitura/Kitura) project. Kitura-net underpins Kitura which offers a higher abstraction level to users.

Kitura-net utilises the [BlueSocket](https://github.com/Kitura/BlueSocket) framework, the [BlueSSLService](https://github.com/Kitura/BlueSSLService.git) framework and [CCurl](https://github.com/Kitura/CCurl.git).

## Features

- Port Listening
- FastCGI Server support
- HTTP Server support (request and response)

## Usage

#### Add dependencies

Add the `Kitura-net` package to the dependencies within your application’s `Package.swift` file. Substitute `"x.x.x"` with the latest `Kitura-net` [release](https://github.com/Kitura/Kitura-net/releases).

```swift
.package(url: "https://github.com/Kitura/Kitura-net.git", from: "x.x.x")
```

Add `KituraNet` to your target's dependencies:

```swift
.target(name: "example", dependencies: ["KituraNet"]),
```

#### Import package

```swift
import KituraNet
```

## Prerequisites

As of Kitura-net 3.0.0, Swift 5.1+ is required.

## Contributing to Kitura-net

All improvements to Kitura-net are very welcome! Here's how to get started with developing Kitura-net itself.

1. Clone this repository.

`$ git clone https://github.com/Kitura/Kitura-net && cd Kitura-net`

2. Build and run tests.

`$ swift test`

You can find more info on contributing to Kitura in our [contributing guidelines](https://github.com/Kitura/Kitura/blob/master/.github/CONTRIBUTING.md).

## API Documentation
For more information visit our [API reference](https://kitura.github.io/Kitura-net/index.html).

## Community

We love to talk server-side Swift, and Kitura. Join our [Slack](http://swift-at-ibm-slack.mybluemix.net/) to meet the team!

## License
This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/Kitura/Kitura-net/blob/master/LICENSE.txt).