spiff-arena/docs/dev/connector_proxy.md
Kevin Burnett 5df1262dca
Proofing updates (#1838)
* update in place with python

* split files into chunks

* working chunking and updated quick start

* edits

* sanity check

* give up on faq page, long docs work

* debug

* system prompt updates, etc

* use temp file for output

* refactor

* remove dup import

* generate diff file

* check diff output to make sure it looks reasonable

* add overall results

* update script

* update script

* update script

* edits

* fix function

---------

Co-authored-by: burnettk <burnettk@users.noreply.github.com>
2024-06-28 08:03:25 -07:00

32 lines
1.1 KiB
Markdown

# Connector Proxy
A connector-proxy is an application that is generally deployed alongside the frontend and backend.
Please see [Connector Proxy in 5 mins](https://github.com/sartography/spiff-arena/wiki/Connector-Proxy-in-5-mins).
```mermaid
graph TD
subgraph ConnectorProxy[Connector Proxy Application]
direction TB
ConnectorA
ConnectorB
end
subgraph ConnectorA[Connector A]
direction TB
CommandA1[Command C]
CommandA2[Command D]
end
subgraph ConnectorB[Connector B]
direction TB
CommandB1[Command E]
CommandB2[Command F]
end
```
Connector proxies are containers for connectors.
Connectors are usually Python libraries that are included in connector proxy codebases, but they can also be embedded directly inside of connector proxies.
Our connector-proxy-demo includes a few connectors, including [connector-aws](https://github.com/sartography/connector-aws) and [connector-http](https://github.com/sartography/connector-http).
Connector-http can be used for many API interactions, but you can also [write your own connectors](/dev/how_to_build_a_connector).