README
¶
Slide, a Go web framework for Building API(s)
Slide is one of the fastest frameworks, built on top of fasthttp. People coming form express will feel at home.
Motivation
While playing around with the Go’s net/http, one thing that we missed most was the lack of middleware support and the problems it solves. After a little reading, we decided to write our own web framework which would solve the issues like middleware support with next, handle a wide range of files, Upload, Download, etc.
💡 Note: We are still in experimental stage, would love to hear feedback.
Installation
go get -u github.com/go-slide/slide
🚀 Example
For more API information check Docs
package main
import (
"log"
"github.com/go-slide/slide"
"github.com/go-playground/validator/v10"
)
func main() {
validate := validator.New()
config := slide.Config{
Validator: validate,
}
app := slide.InitServer(&config)
app.Get("/", func(ctx *slide.Ctx) error {
return ctx.Send(http.StatusOK, "Hello, World")
})
log.Fatal(app.Listen("localhost:4321"))
}
Routing
Slide supports multilevel routing.
app := slide.InitServer(&config)
app.Get("/", func(ctx *slide.Ctx) error {
return ctx.Send(http.StatusOK, "Hello, World")
})
// Grouping your route
auth := app.Group("/auth")
auth.Get("/login", func(ctx *slide.Ctx) error {
return ctx.Send(http.StatusOK, "Hello, World")
})
Middleware
Slide supports wide range of middlewares.
- Application Level
- Group Level
- Route Level
app := slide.InitServer(&config)
## Application level
app.Use(func(ctx *slide.Ctx) error {
fmt.Println("this will run for all URL(s)")
return ctx.Next()
})
//Group Level
auth := app.Group("/auth")
auth.Use(func(ctx *slide.Ctx) error {
fmt.Println("this will run for all /auth URL(s)")
return ctx.Next()
})
auth.Get("/login", func(ctx *slide.Ctx) error {
return ctx.Send(http.StatusOK, "Hello, World")
})
// Route level, works in Right -> Left or Bottom to Top
app.Get("/routermiddleware", func(ctx *slide.Ctx) error {
return ctx.Send(http.StatusOK, "hola!")
}, func(ctx *slide.Ctx) error {
fmt.Println("this prints second", ctx.RequestCtx.UserValue("lol"))
return ctx.Next()
}, func(ctx *slide.Ctx) error {
fmt.Println("this prints first")
return ctx.Next()
})
Benchmark
autocannon -c 100 -d 40 -p http://localhost:4321/
| Framework | No of requests |
|---|---|
| Slide | 2765K |
Documentation
¶
Index ¶
- Constants
- type Config
- type Ctx
- func (ctx *Ctx) Bind(input interface{}) error
- func (ctx *Ctx) GetParam(name string) string
- func (ctx *Ctx) GetParams() map[string]string
- func (ctx *Ctx) GetQueryParam(name string) string
- func (ctx *Ctx) GetQueryParams() map[string]string
- func (ctx *Ctx) JSON(statusCode int, payload interface{}) error
- func (ctx *Ctx) Redirect(statusCode int, url string) error
- func (ctx *Ctx) Send(statusCode int, payload string) error
- func (ctx *Ctx) SendAttachment(filePath, fileName string) error
- func (ctx *Ctx) SendStatusCode(statusCode int) error
- func (ctx *Ctx) ServeFile(filePath string) error
- func (ctx *Ctx) UploadFile(filePath, fileName string) error
- type Group
- type Slide
- func (slide *Slide) Delete(path string, h ...handler)
- func (slide *Slide) Get(path string, h ...handler)
- func (slide *Slide) Group(path string) *Group
- func (slide *Slide) HandleErrors(h errHandler)
- func (slide *Slide) HandleNotFound(h handler)
- func (slide *Slide) Listen(host string) error
- func (slide *Slide) Post(path string, h ...handler)
- func (slide *Slide) Put(path string, h ...handler)
- func (slide *Slide) ServeFile(path, filePath string)
- func (slide *Slide) ServerDir(path, dir string)
- func (slide *Slide) Use(h handler)
Constants ¶
const ( GET = http.MethodGet POST = http.MethodPost PUT = http.MethodPut DELETE = http.MethodDelete ContentType = "Content-Type" ContentDeposition = "Content-Disposition" ApplicationJSON = "application/json" Attachment = "attachment" // cors headers HeaderOrigin = "Origin" HeaderVary = "Vary" HeaderAccessControlAllowOrigin = "Access-Control-Allow-Origin" HeaderAccessControlAllowMethods = "Access-Control-Allow-Methods" HeaderAccessControlAllowCredentials = "Access-Control-Allow-Credentials" HeaderAccessControlExposeHeaders = "Access-Control-Expose-Headers" HeaderAccessControlRequestMethod = "Access-Control-Request-Method" HeaderAccessControlRequestHeaders = "Access-Control-Request-Headers" HeaderAccessControlAllowHeaders = "Access-Control-Allow-Headers" HeaderAccessControlMaxAge = "Access-Control-Max-Age" // routing error messages NotFoundMessage = "Not Found, Check URL" )
...
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
Validator *validator.Validate
}
Config -- Configuration for slide
type Ctx ¶
type Ctx struct {
RequestCtx *fasthttp.RequestCtx
Next func() error
// contains filtered or unexported fields
}
Ctx -- route level context
func (*Ctx) GetParam ¶
GetParam - Getting path param
/name/:name
/name/slide
name := ctx.GetParam("name")
name = slide
func (*Ctx) GetParams ¶
GetParams returns map of path params
routerPath /auth/:name/:age
requestPath /auth/madhuri/32
returns { name: madhuri, age: 32 }
func (*Ctx) GetQueryParam ¶
GetQueryParam returns value of a single query Param
route path /hello?key=test&value=bbp keyValue = GetQueryParam(key) keyValue = test
func (*Ctx) GetQueryParams ¶
GetQueryParams returns map of query Params
route path /hello?key=test&value=bbp
returns {key : test, value : bbp}
func (*Ctx) Redirect ¶
Redirect to new url reference https://developer.mozilla.org/en-US/docs/Web/HTTP/Redirections#Temporary_redirections status codes between 300-308
func (*Ctx) SendStatusCode ¶
SendStatusCode -- sending response without any body
func (*Ctx) UploadFile ¶
UploadFile uploads file to given path
type Slide ¶
type Slide struct {
// contains filtered or unexported fields
}
Slide -- Slide config
func InitServer ¶
InitServer -- initializing server with slide config
func (*Slide) HandleErrors ¶
func (slide *Slide) HandleErrors(h errHandler)
HandleErrors Handling errors at application level
func (*Slide) HandleNotFound ¶
func (slide *Slide) HandleNotFound(h handler)
HandleNotFound custom 404 handler
Source Files
Directories