Code Monkey home page Code Monkey logo

ghost's Introduction

Ghost - Build REST APIs from structs using Generics

Why Ghost?

We all love Go for it's high performance IO, Goroutines, channels etc but we also have to write boring REST APIs that required a lot of hand code writing. We had to repeat ourselves for each resource and when I read the "When To Use Generics" I thought, REST APIs are not a collection, but we are actually writing the exact same code multiple times. Is building REST APIs a generics thing? What's the minimal we could write to get a REST API?

What is Ghost?

Ghost is a collection of generic structs and interfaces that when composed, become a http.Handler that provides a REST API.

type User struct {
	Name string
}

type SearchQuery struct {
	Name string
}

func main() {
	store := ghost.NewMapStore(&User{}, SearchQuery{}, uint64(0))
	g := ghost.New(store)
	// g is a http.Handler and it provides GET /?name=:name, GET /:userid, POST /, PUT /:userid, DELETE /:userid
	http.ListenAndServe("127.0.0.1:8080", g)
}

Minimal work is to write your struct, choose a store from the stores and call ghost.New.
In reality you would write your own store. That's where the business logic is, and what translates into value.

What is generic in Ghost?

Ghost has 3 type parameters, R Resource, Q Query and P PKey.

Resource is the REST resource. Ghost provides CRUD operations for resources.

Query represents the query when searching for resources to return a list.

PKey is a key that identifies the resource. A primary key.

Types in Ghost

TODO

  • Validator
  • Hooks
  • Example using common ORMs
  • OpenAPIv3 integration

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.