The highest tagged major version is
README
¶
Cyclops
Features
- Plug and Play Middleware support
- Plug and Play Alerting support
- Customized response messages
Table of contents
Usage
package main
import (
"fmt"
"github.com/flannel-dev-lab/cyclops"
"github.com/flannel-dev-lab/cyclops/response"
"github.com/flannel-dev-lab/cyclops/router"
"github.com/flannel-dev-lab/cyclops/middleware"
"net/http"
)
func main() {
routerObj := router.New(false, nil, nil)
routerObj.Get("/hello", middleware.NewChain().Then(Hello))
routerObj.Post("/bye", Bye)
// Named parameters can be used as
routerObj.Get("/users/:name", middleware.NewChain().Then(PathParam))
// static can be registered as
routerObj.RegisterStatic("{PATH TO STATIC DIRECTORY}", "/static/")
cyclops.StartServer(":8080", routerObj)
}
func PathParam(w http.ResponseWriter, r *http.Request) {
fmt.Fprintf(w, "Hi %s", cyclops.Param(r, "name"))
response.SuccessResponse(200, w, nil)
}
func Hello(w http.ResponseWriter, r *http.Request) {
response.SuccessResponse(200, w, nil)
}
func Bye(w http.ResponseWriter, r *http.Request) {
response.SuccessResponse(200, w, nil)
}
Credits
- Router implementation is inspired and modified accordingly from vestigo
Documentation
¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package alerts handles the alerting systems such as Sentry, etc Package sentry implements the Alert interface for Sentry alerting systems
|
Package alerts handles the alerting systems such as Sentry, etc Package sentry implements the Alert interface for Sentry alerting systems |
|
Package cookie deals with set, get and deleting of HTTP Cookies
|
Package cookie deals with set, get and deleting of HTTP Cookies |
|
input deals with getting the values from form and query parameters
|
input deals with getting the values from form and query parameters |
|
middleware package includes different middleware available by default with cyclops, cyclops is made in such a way that it is easy for developers to plug custom middleware as well, the only thing that the developer need to do is write a middleware that takes in a http.Handler and returns a http.Handler, once the middleware is complete pass it to NewChain method to start using it
|
middleware package includes different middleware available by default with cyclops, cyclops is made in such a way that it is easy for developers to plug custom middleware as well, the only thing that the developer need to do is write a middleware that takes in a http.Handler and returns a http.Handler, once the middleware is complete pass it to NewChain method to start using it |
|
requester package is used to perform basic http requests
|
requester package is used to perform basic http requests |
Click to show internal directories.
Click to hide internal directories.