# Product OS : Connector

Product OS : Connector provides a framework for definining a server with APIs, outward API calls, a workflow to pass data along, all using only configuration that can be defined in JSON or Yaml.  This flexible and powerful framework is akin to using automation tools like Zapier and IFTTT and tray.io and supports using OpenAPI / Swagger defined APIs.

### What is Product OS?

Product OS is a collection of packages that provide different tools and features that can work together to build products more easily for the Rust ecosystem.

## Installation

Use the Rust crate package manager [cargo](https://www.rust-lang.org/tools/install) to install Product OS : Connector.

```bash
cargo add product-os-connector
```

or add Product OS : Connector to your cargo.toml ```[packages]``` section.

```rust
product-os-connector = { version = "0.0.19", features = [], default-features = true, optional = false }
```

## Features

Product OS Connector supports a number of features leveraging existing Rust libraries to help connect APIs together using only configuration:

- Define server with a set of inward APIs using only configuration
- Define a set of outward APIs that can be called using only configuration
- Supports REST, GraphQL and Web Sockets initially
- Supports a number of authentication methods
- Import OpenAPI / Swagger definitions easily for outward API calls
- Define a workflow by passing data along from inward calls, passed through outward calls, data manipulation and then response
- Supports no_std with alloc only environments

To make the most of Connector, you should use the Product OS : Server crate.

```rust
// Feature samples TODO
```

## Usage

```rust
// Examples TODO
```

## Contributing

Contributions are not currently available but will be available on a public repository soon.

## License

[GNU AGPLv3](https://choosealicense.com/licenses/agpl-3.0/)