README
¶
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
Documentation
¶
Index ¶
- Variables
- func DefaultErrorHandler(encoding Encoding[Error]) func(err error) http.Handler
- func New[R Resource, Q Query, P PUintKey](store Store[R, Q, P]) http.Handler
- func NewS[R Resource, Q Query, P PStrKey](store Store[R, Q, P]) http.Handler
- func StrPath[P PStrKey](s string) (P, error)
- func UintPath[P PUintKey](s string) (P, error)
- type AfterCreate
- type AfterDelete
- type AfterList
- type AfterRead
- type AfterUpdate
- type BeforeCreate
- type BeforeDelete
- type BeforeList
- type BeforeRead
- type BeforeUpdate
- type Encoding
- type Error
- type Ghost
- type Handler
- type Identifier
- type JSON
- type PKey
- type PStrKey
- type PUintKey
- type PathIdentifier
- type Querier
- type Query
- type QueryParser
- type Resource
- type Server
- type Store
Constants ¶
This section is empty.
Variables ¶
var ErrMethodNotAllowed = Error{ Code: http.StatusMethodNotAllowed, Err: errors.New(http.StatusText(http.StatusMethodNotAllowed)), }
var ErrNotFound = Error{ Code: http.StatusNotFound, Err: errors.New(http.StatusText(http.StatusNotFound)), }
Functions ¶
func DefaultErrorHandler ¶
Types ¶
type AfterCreate ¶
type BeforeCreate ¶
type BeforeRead ¶
type Error ¶
func (Error) MarshalJSON ¶
type Ghost ¶
type JSON ¶
type JSON[R Resource] struct{}
JSON is an Encoding.
func (JSON[R]) EncodeEmpty ¶
func (j JSON[R]) EncodeEmpty(w http.ResponseWriter, code int) error
func (JSON[R]) EncodeList ¶
func (j JSON[R]) EncodeList(w http.ResponseWriter, rs []R, code int) error
type PKey ¶
type PKey interface {
comparable
}
type PStrKey ¶
type PStrKey interface {
comparable
string
}
type PathIdentifier ¶
PathIdentifier is an Identifier which extracts the PKey from the request URL path.
type QueryParser ¶
type QueryParser[Q Query] struct { // contains filtered or unexported fields }
QueryParser is a Querier which maps the URL query parameters to a Query.
func NewQueryParser ¶
func NewQueryParser[Q Query]() QueryParser[Q]
type Server ¶
type Server interface {
Create(http.ResponseWriter, *http.Request) error
Read(http.ResponseWriter, *http.Request) error
Update(http.ResponseWriter, *http.Request) error
Delete(http.ResponseWriter, *http.Request) error
List(http.ResponseWriter, *http.Request) error
}
Source Files
Directories