README
¶
Go Webserver
This is an experimental web server written in Go. Do not use in production.
How to get set up
Create a new Go project and put this in your main.go file:
package main
import (
"fmt"
"fetch/core"
)
func main() {
app := core.Server{}
app.Setup()
app.GetRouter().Get("/", homeHandler)
app.Start()
}
func homeHandler(w core.Response, r core.Request) {
fmt.Fprint(w, "Hello Go!\n")
}
You can change the port by setting the "_port" parameter on the Server struct:
app := core.Server{Port: "80"}
If you're using SSL or static file hosting, it's important to specify the projects base directory in the server struct:
baseDir, _ := os.Getwd()
app := core.Server{BaseDir: baseDir}
Documentation
¶
Overview ¶
Package fetch - core web server code
Index ¶
- func Init(router *Router)
- type DatabaseStruct
- type Request
- type RequestHandler
- type Response
- type Router
- func (router *Router) Delete(route string, h RequestHandler) error
- func (router *Router) Get(route string, h RequestHandler) error
- func (router *Router) Head(route string, h RequestHandler) error
- func (router *Router) Options(route string, h RequestHandler) error
- func (router *Router) Post(route string, h RequestHandler) error
- func (router *Router) Put(route string, h RequestHandler) error
- func (router *Router) SetupRoutes(mux *http.ServeMux)
- type Server
- func (server *Server) AddHeader(key string, value string)
- func (server *Server) Cleanup()
- func (server *Server) GetDatabase() (*gorm.DB, error)
- func (server *Server) GetHeaders() map[string]string
- func (server *Server) GetRouter() *Router
- func (server *Server) RemoveHeader(key string) error
- func (server *Server) SetRouter(router *Router)
- func (server *Server) Setup() error
- func (server *Server) Start()
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type DatabaseStruct ¶
type DatabaseStruct struct {
Database string
Driver string
Username string
Password string
Port uint16
}
DatabaseStruct stores necessary details for database connection
type RequestHandler ¶
RequestHandler type is a placeholder for http.HandlerFunc
type Response ¶
type Response struct {
http.ResponseWriter
}
Response type is a placeholder for http.ResponseWriter
type Router ¶
type Router struct {
GetRegister map[string]RequestHandler
HeadRegister map[string]RequestHandler
PostRegister map[string]RequestHandler
PutRegister map[string]RequestHandler
DeleteRegister map[string]RequestHandler
OptionRegister map[string]RequestHandler
}
Router struct to handle route registration
func (*Router) Delete ¶
func (router *Router) Delete(route string, h RequestHandler) error
Delete registers a DELETE request route
func (*Router) Get ¶
func (router *Router) Get(route string, h RequestHandler) error
Get registers a GET request route
func (*Router) Head ¶
func (router *Router) Head(route string, h RequestHandler) error
Head registers a HEAD request route
func (*Router) Options ¶
func (router *Router) Options(route string, h RequestHandler) error
Options registers a Options request route
func (*Router) Post ¶
func (router *Router) Post(route string, h RequestHandler) error
Post registers a POST request route
func (*Router) Put ¶
func (router *Router) Put(route string, h RequestHandler) error
Put registers a PUT request route
func (*Router) SetupRoutes ¶
SetupRoutes takes care of initialising the routes from the register
type Server ¶
Server is the... server
func (*Server) Cleanup ¶
func (server *Server) Cleanup()
Cleanup cleans up any connections the server might have when it's terminated
func (*Server) GetDatabase ¶
GetDatabase gets the active database connection
func (*Server) GetHeaders ¶
GetHeaders returns all custom set headers
func (*Server) RemoveHeader ¶
RemoveHeader removes a custom set header
Source Files
Directories