go-codon

by grofers

grofers / go-codon

Workflow based REST framework code generator

130 Stars 7 Forks Last release: about 3 years ago (v0.3) MIT License 100 Commits 2 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

go-codon

Generates Go server code from a combination of REST and Workflow DSLs.

Build Status

A codon service has three components: -

Server
: Accepts and validates HTTP requests -
Clients
: Clients for upstream services which this service consumes -
Workflows
: Procedures for every REST endpoint of this server which consume Clients and other custom actions.

Server and Client side specifications are written in Swagger. Swagger code generation is done through go-swagger. Workflow is written in

Flow
, a Mistral inspired workflow specification in YAML. Its specification can be found here.

Check out wiki section for more information. Follow this tutorial for a very basic example on how to use this tool.

Installation

Set up your Golang development environment (Getting Started). Set your

GOPATH
and
GOBIN
directories. Also add
GOBIN
to your
PATH
so that golang tools can be used in command line.

Download the latest binary from Github releases and put it in your

GOBIN
directory. Or to install from source do:
sh
mkdir -p $GOPATH/src/github.com/grofers
cd $GOPATH/src/github.com/grofers
git clone [email protected]:grofers/go-codon.git
cd go-codon
make install

Example

This is what a workflow looks like (for an API to get posts and the comments for each post concurrently):

yaml
name: get_posts_comments
start:
    - get_posts
tasks:
    get_posts:
        action: clients.jplaceholder.get_posts
        input:
            userId: 
        publish:
            posts: 
        on-success:
            - get_all_comments: true
    get_comments:
        action: clients.jplaceholder.get_comments
        input:
            postId: 
        publish:
            comments: 
    get_all_comments:
        with-items: 
        loop:
            task: get_comments
            input:
                postId: 
            publish:
                combined: 
output:
    body: 
    status_code: 200
To run this example checkout examples.

Projects go-codon would not exist without

(Or just projects I am really thankful for) - go-swagger: Provides code generators for client and server side components using Swagger specification. - go-jmespath: Allows for easy querying and manipulation of json objects in workflows. - Pongo2: Django template renderer. Used for templates and workflow expressions in codon. - Mistral DSL: A workflow spec used for infrastructure orchestration. Codon's workflow DSL is inspired from Mistral's but modified for use in REST context. - mapstructure

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.