README
¶
🍑 GoPeach
GoPeach is a fasthttp based framework 😃 made to simplify fasthttp while keeping its performance.
GoPeach also integrats a database structure to allow you to implement gorm easily.
go get -u github.com/Cypaaa/gopeach
Quickstart
package main
import (
"github.com/Cypaaa/gopeach"
)
func main() {
app := gopeach.New()
app.Get("/", func(ctx *gopeach.RequestCtx) {
ctx.Send("Hello World!")
})
app.Listen(":8080")
}
🔒 JWT and Scrypt
GoPeach implements 4 functions to help you use JWT (EdDSA) and Scrypt.
- JWT: GenerateJWT, VerifyJWT
- Scrypt: Hash, CompareHash
You will find examples in the example directory.
👨💻👩💻 Middlewares
You can add custom or community made middlewares!
They handle a request in order they are defined.
Your first middleware will be executed before your second one which itself will execute before your handler
func main() {
app := gopeach.New()
// Your first middleware
app.Middleware(func(ctx *gopeach.RequestCtx) {
fmt.Println("This is your first middleware")
// Pass to the next handler only if method is "GET"
// else the request won't be handled anymore
if ctx.MethodString() == "GET" {
ctx.Next()
return
}
})
// Your second middleware
app.Middleware(func(ctx *gopeach.RequestCtx) {
fmt.Println("This is your second one")
ctx.Next()
})
// Get all routes
app.Get("/", func(ctx *gopeach.RequestCtx) {
ctx.Send("Hello World!")
})
app.Listen(":8080")
}
📓 Database
func main() {
godotenv.Load()
// Dialector
dns := fmt.Sprintf("%s:%s@tcp(%s:%s)/%s?charset=utf8mb4&parseTime=True&loc=Local",
os.Getenv("DB_USER"),
os.Getenv("DB_PASSWORD"),
os.Getenv("DB_HOST"),
os.Getenv("DB_PORT"),
os.Getenv("DB_NAME"),
)
dialector := mysql.Open(dns)
// Database
db, err := gopeach.NewDatabase(dialector)
if err != nil {
log.Fatal(err)
}
defer db.Close()
err = db.Migrate(
models.MyModelTest{},
// ...
)
if err != nil {
log.Fatal(err)
}
}
Documentation
¶
Index ¶
- Constants
- func CompareHash(s, hash string) (bool, error)
- func GenerateJWT(jwtSecretKey ed25519.PrivateKey, mc jwtv5.MapClaims) (string, error)
- func Hash(s string) (string, error)
- func VerifyJWT(jwtSecretKey ed25519.PublicKey, token string, opts ...jwtv5.ParserOption) (jwtv5.MapClaims, error)
- type App
- func (r *App) CaseSensitive(b bool)
- func (r *App) Delete(s string, h func(ctx *RequestCtx))
- func (r *App) Get(s string, h func(ctx *RequestCtx))
- func (r *App) Handler(ctx *fasthttp.RequestCtx)
- func (r *App) Listen(addr string) error
- func (r *App) ListenTLS(addr, certFile, keyFile string) error
- func (r *App) Middleware(h func(ctx *RequestCtx))
- func (r *App) Patch(s string, h func(ctx *RequestCtx))
- func (r *App) Post(s string, h func(ctx *RequestCtx))
- func (r *App) Put(s string, h func(ctx *RequestCtx))
- type Database
- func (d *Database) Close() error
- func (d *Database) Conn() *gorm.DB
- func (d *Database) Delete(i interface{}) error
- func (d *Database) DeleteByQuery(i interface{}, query interface{}, args ...interface{}) error
- func (d *Database) Destroy(i interface{}) error
- func (d *Database) Find(i interface{}) error
- func (d *Database) FindByQuery(i interface{}, query interface{}, args ...interface{}) error
- func (d *Database) FindCond(i, c interface{}) error
- func (d *Database) First(i, c interface{}) error
- func (d *Database) FirstByQuery(i interface{}, query interface{}, args ...interface{}) error
- func (d *Database) Init() error
- func (d *Database) Migrate(i ...interface{}) error
- func (d *Database) Save(i interface{}) error
- type HTTPResponse
- func (e *HTTPResponse) Accepted(message, path string) *HTTPResponse
- func (e *HTTPResponse) BadRequest(message, path string) *HTTPResponse
- func (e *HTTPResponse) Conflict(message, path string) *HTTPResponse
- func (e *HTTPResponse) Created(message, path string) *HTTPResponse
- func (e *HTTPResponse) Forbidden(message, path string) *HTTPResponse
- func (e *HTTPResponse) InternalServerError(message, path string) *HTTPResponse
- func (e *HTTPResponse) NotFound(message, path string) *HTTPResponse
- func (e *HTTPResponse) ToJson() string
- func (e *HTTPResponse) Unauthorized(message, path string) *HTTPResponse
- type RequestCtx
- func (ctx *RequestCtx) Cookie(name string) string
- func (ctx *RequestCtx) Header(key string) string
- func (ctx *RequestCtx) MethodString() string
- func (ctx *RequestCtx) Next()
- func (ctx *RequestCtx) PathString() string
- func (ctx *RequestCtx) Send(s string)
- func (ctx *RequestCtx) SetContentType(contentType string)
- func (ctx *RequestCtx) SetCookie(cookie *fasthttp.Cookie)
- func (ctx *RequestCtx) SetHeader(key, value string)
- func (ctx *RequestCtx) SetStatusCode(statusCode int)
- type Route
Constants ¶
const ( // DefaultSaltLength is the default salt length. DefaultSaltLength = 32 // DefaultHashLength is the default hash length. DefaultHashLength = 64 )
Variables ¶
This section is empty.
Functions ¶
func CompareHash ¶
Compare compares a string and a hash.
func GenerateJWT ¶
Generate generates a JWT token. It takes a jwtSecretKey string and a struct (interface{}) jwtSecretKey must be EdDSA private key and returns a token and an error.
Types ¶
type App ¶
type App struct {
// contains filtered or unexported fields
}
App stores Routes and middlewares
func (*App) CaseSensitive ¶
CaseSensitive sets if the routes should be checked with case sensitivity
func (*App) Delete ¶
func (r *App) Delete(s string, h func(ctx *RequestCtx))
Delete adds DELETE Route.
func (*App) Middleware ¶
func (r *App) Middleware(h func(ctx *RequestCtx))
Middleware adds middleware
type Database ¶
type Database struct {
// contains filtered or unexported fields
}
Database struct
func NewDatabase ¶
NewDatabase creates a new database connection
func (*Database) DeleteByQuery ¶
DeleteByQuery deletes the model by query
func (*Database) FindByQuery ¶
FindByQuery finds the model by query
func (*Database) First ¶
First finds the first model by custom cudition from the same structure (findOne)
func (*Database) FirstByQuery ¶
FirstByQuery finds the first model by query (findOne)
type HTTPResponse ¶
Error represents an http error.
func (*HTTPResponse) Accepted ¶
func (e *HTTPResponse) Accepted(message, path string) *HTTPResponse
Accepted returns a new HTTPResponse with status 202.
func (*HTTPResponse) BadRequest ¶
func (e *HTTPResponse) BadRequest(message, path string) *HTTPResponse
BadRequest returns a new HTTPResponse with status 400.
func (*HTTPResponse) Conflict ¶
func (e *HTTPResponse) Conflict(message, path string) *HTTPResponse
Conflict returns a new HTTPResponse with status 409.
func (*HTTPResponse) Created ¶
func (e *HTTPResponse) Created(message, path string) *HTTPResponse
Created returns a new HTTPResponse with status 201.
func (*HTTPResponse) Forbidden ¶
func (e *HTTPResponse) Forbidden(message, path string) *HTTPResponse
Forbidden returns a new HTTPResponse with status 403.
func (*HTTPResponse) InternalServerError ¶
func (e *HTTPResponse) InternalServerError(message, path string) *HTTPResponse
InternalServerError returns a new HTTPResponse with status 500.
func (*HTTPResponse) NotFound ¶
func (e *HTTPResponse) NotFound(message, path string) *HTTPResponse
NotFound returns a new HTTPResponse with status 404.
func (*HTTPResponse) ToJson ¶
func (e *HTTPResponse) ToJson() string
ToJson returns the HTTPResponse as a JSON string.
func (*HTTPResponse) Unauthorized ¶
func (e *HTTPResponse) Unauthorized(message, path string) *HTTPResponse
Unauthorized returns a new HTTPResponse with status 401.
type RequestCtx ¶
type RequestCtx struct {
*fasthttp.RequestCtx
Params map[string]string
JsonBody map[string]interface{}
Nexts []func(ctx *RequestCtx)
// contains filtered or unexported fields
}
RequestCtx is an extension of fasthttp.RequestCtx
func NewRequestCtx ¶
func NewRequestCtx(ctx *fasthttp.RequestCtx, h []func(ctx *RequestCtx)) *RequestCtx
NewRequestCtx returns a new RequestCtx
func (*RequestCtx) Cookie ¶
func (ctx *RequestCtx) Cookie(name string) string
Cookie returns cookie value by name
func (*RequestCtx) Header ¶
func (ctx *RequestCtx) Header(key string) string
GetHeader returns the request header with key
func (*RequestCtx) MethodString ¶
func (ctx *RequestCtx) MethodString() string
Method returns the request method
func (*RequestCtx) PathString ¶
func (ctx *RequestCtx) PathString() string
Path returns the request path
func (*RequestCtx) SetContentType ¶
func (ctx *RequestCtx) SetContentType(contentType string)
SetContentType sets the response content type
func (*RequestCtx) SetCookie ¶
func (ctx *RequestCtx) SetCookie(cookie *fasthttp.Cookie)
SetCookie sets cookie.
func (*RequestCtx) SetHeader ¶
func (ctx *RequestCtx) SetHeader(key, value string)
SetHeader sets the response header with key, value pair
func (*RequestCtx) SetStatusCode ¶
func (ctx *RequestCtx) SetStatusCode(statusCode int)
SetStatusCode sets the response status code
type Route ¶
type Route struct {
Path string
ParamIndexes map[string]uint // map[string]uint{"id": 0, "name": 1, ...}
Handler func(ctx *RequestCtx)
}
Route stores path, param indexes and handler.
func NewRoute ¶
func NewRoute(path string, h func(ctx *RequestCtx)) Route
NewRoute takes a path string and an handler function and returns new Route.
Source Files
Directories