Code Monkey home page Code Monkey logo

jrpc-go's Introduction

jrpc-go

jrpc-go lets you create a generated JSON API server by just specifying handler methods. For example, you can write:

package service

//go:generate jrpc-go -genpkg handlers -receiver Service

type Service struct{}

type User struct {
  ID       string
  Username string
}

func (s *Service) CreateUser(ctx context.Context, username string) (*User, error) {
  // <Insert a user into a database here>
  return &User{
    ID:       "random-uuid",
    Username: username,
  }, nil
}

...and run go generate. Any exported functions that you define in the package that you run jrpc-go for will be wrapped in HTTP request handlers.

The generated code (which you can see in example/handlers) will:

  • Expose a function that creates a new http.ServeMux with handlers for each of your exported methods (e.g. /CreateUser)
  • Create input structures for each method (e.g. struct{Username string})
  • Automatically unmarshal JSON from requests and marshal response structures
  • Write an error in the response if your handler errors

You can use the generated code like this:

func main() {
  svc := &example.Service{}
  mux := handlers.HTTPHandler(svc)
  log.Fatal(http.ListenAndServe(":7744", mux))
}

jrpc-go's People

Contributors

olafal0 avatar

Stargazers

H avatar

Watchers

Kostas Georgiou avatar  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.