pipeline

package module
v0.0.0-...-9fb4de0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 17, 2020 License: MIT Imports: 0 Imported by: 0

README

GoDoc CI

pipeline

Unix pipelines in golang, configured by json.

See godocs for more info.

Documentation

Overview

package pipeline is a library intended to help build dynamic request pipelines

Why?

Let's imagine you'd like to wrap an existing Restful API which uses a special format of JSON messages to communicate. The problem is that you have to transform the message on the way to the API as well as transform the response and the way back. To solve the problem you would usually have to write custom code to wrap such API.

This library is intended to write a simple pipeline in JSON format to solve this problem without writing any code. As the format to define a pipeline is JSON it's very easy to create/configure a pipeline from a JavaScript environment, e.g. a browser.

Example: 1. user makes a request with a JSON body 2. the first pipeline step transforms the JSON body 3. the second pipeline step makes a HTTP request with the transformed JSON body 4. the third pipeline step takes the JSON response from the request and transforms it again 5. the client gets back the transformed JSON, not needing to know that the intermediate formats of the JSON got transformed

Directories

Path Synopsis
pkg
pipe
package pipe initializes, configures and runs a pipeline
package pipe initializes, configures and runs a pipeline
step
package step holds all possible steps to create pipelines
package step holds all possible steps to create pipelines

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL