Giter Site home page Giter Site logo

kitboiler's Introduction

KitBoiler

KitBoiler generates endpoints, request/response types, request decoders and http handlers for use with Go kit (https://gokit.io), based on an interface that defines a service.

NOTE: KitBoiler is still work in progress and may or may not work as advertised. It probably won't eat your cat although you can't be sure until it does.

Usage

Given a service definition/interface in github.com/me/mypkg/api/somefile.go:

type MyService interface {
    MyFirstFunction(name string) (err error)
    MyFirstQuery() (results []*model.QueryResult, err error)
    MySecondQuery() (result *somepkg.FooBar, err error)
}

NOTE: you HAVE to provide names for both the parameters and the return vars in your interface definition as those are used by kitboiler. Choose the names wisely as they will become part of your public interface.

You should call KitBoiler like:

kitboiler github.com/me/mypkg/api.MyService 

This generates a package containing endpoint functions, request/response types and http handler functions for all functions defined in the interface specification.

Implementation is based on the impl package by Josh Snyder (https://github.com/josharian/impl) and inspiration was generously provided by SQLBoiler (https://github.com/volatiletech/sqlboiler)

kitboiler's People

Contributors

jeroenvand avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.