Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grofers/go-codon
Workflow based REST framework code generator
https://github.com/grofers/go-codon
aggregation concurrency golang mistral rest rest-api swagger web web-framework workflow workflows
Last synced: 4 days ago
JSON representation
Workflow based REST framework code generator
- Host: GitHub
- URL: https://github.com/grofers/go-codon
- Owner: grofers
- License: mit
- Created: 2017-04-18T14:09:43.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-09-01T09:47:31.000Z (about 1 year ago)
- Last Synced: 2024-05-21T19:16:59.957Z (6 months ago)
- Topics: aggregation, concurrency, golang, mistral, rest, rest-api, swagger, web, web-framework, workflow, workflows
- Language: Go
- Size: 172 KB
- Stars: 142
- Watchers: 96
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-codon
Generates Go server code from a combination of REST and Workflow DSLs.
[](https://travis-ci.org/grofers/go-codon)
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](https://github.com/grofers/go-codon/wiki/Workflow-DSL-Specification).
Check out [wiki](https://github.com/grofers/go-codon/wiki) section for more information. Follow [this tutorial](https://github.com/grofers/go-codon/wiki/Codon:-REST-Workflow-Framework) for a very basic example on how to use this tool.
## Installation
Set up your Golang development environment ([Getting Started](https://golang.org/doc/install)). 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: <%jmes main.userId %>
publish:
posts: <%jmes action %>
on-success:
- get_all_comments: true
get_comments:
action: clients.jplaceholder.get_comments
input:
postId: <%jmes main.postId %>
publish:
comments: <%jmes action %>
get_all_comments:
with-items: <%jmes main.posts %>
loop:
task: get_comments
input:
postId: <%jmes item.id %>
publish:
combined: <%jmes {"post_details":item,"comments":task.comments} %>
output:
body: <%jmes main.combined %>
status_code: 200
```
To run this example checkout [examples](https://github.com/grofers/codon-examples).
## Projects go-codon would not exist without
(Or just projects I am really thankful for)
- [go-swagger](https://github.com/go-swagger/go-swagger): Provides code generators for client and server side components using [Swagger](https://swagger.io/) specification.
- [go-jmespath](https://github.com/jmespath/go-jmespath): Allows for easy querying and manipulation of json objects in workflows.
- [Pongo2](https://github.com/flosch/pongo2): Django template renderer. Used for templates and workflow expressions in codon.
- [Mistral DSL](https://docs.openstack.org/mistral/latest/): A workflow spec used for infrastructure orchestration. Codon's workflow DSL is inspired from Mistral's but modified for use in REST context.
- [mapstructure](https://github.com/mitchellh/mapstructure)