README.md

Simple

Simple is a simple web framework written in Go

Functionality

• Layer 7 routing proxy (only URL path)

  Enables more granular routing rules based on HTTP URL paths.

• Middleware

  Allows users to define custom middleware functions to modify or enhance the request/response pipeline.

• Panic recover

  Automatically recovers from panics in your code to prevent your server from crashing.

• Path Routing

  Allows users to define custom routes based on URL paths.

• Group Routing

  Allows users to group routes together and apply common middleware or configuration to them.

Class Diagram

---
title: Simple Web Framework 
---
classDiagram

    class Proxy{
        + GET(proxyPath : String, target : String, handlers : HandlerFunc[])
        + POST(proxyPath : String, target : String, handlers : HandlerFunc[])
        + PUT(proxyPath : String, target : String, handlers : HandlerFunc[])
        + DELETE(proxyPath : String, target : String, handlers : HandlerFunc[])
    }

    note for Simple"

        - Simple and all groups share the same router.

        - Simple need to implement the ServeHTTP method of the Handler interface.

        net/http

            func ListenAndServe(addr string, handler Handler) error {
                server := &Server{Addr: addr, Handler: handler}
                return server.ListenAndServe()
            }

            type Handler interface {
                ServeHTTP(ResponseWriter, *Request)
            }

    "

    class Simple{
        - handler(c : *Context)
        + ServeHTTP(http.ResponseWriter, *http.Request)
    }

    note for group "
    All groups share the same router
    "

    class group{
        - middleware : HandlerFunc[]
        - parent : *group
        - router : *router
    }
    
    class router{
        - addRouter(method : String , fullPath : String ,handlers : HandlerFunc[])
    }

    note for node "
        Trie tree node.
        As shown in the diagram below (Trie Router).
    "

    class node{
        - fullPath : String
        - path : String
        - child : *node[]
        - wildChild : Boolean
        - handlers : HandlerFunc[]
    }

    class Context{
        + Writer : http.ResponseWriter
        + Req : *http.Request 
        + Params : HashMap<String,String>
        - handlers : HandlerFunc[]
    }

    class HandlerFunc{
        <<interface>> 
        - handler(c : *Context)
    }

    Proxy "1" o-- "1" Simple
    Simple "1" o-- "1" group 
    Simple "1" o-- "1" router 
    group "1" o-- "0..*" group
    node "1" o-- "0..*" node
    group "0..1" o-- "1*" router
    router "1" o-- "0..*" node
    node ..> Context
    Simple ..> Context
    Context o--> HandlerFunc
    HandlerFunc ..> Context

Loading

---
title: Trie Router
---
graph TB
    / --->|api| /api
    / --->|productpage| /productpage
    / --->|details| /details
    / --->|reviews| /reviews
    /reviews --->|:product_id| /reviews/:product_id
    /details --->|:product_id| /details/:product_id
    /api --->|v1| /v1  

Loading

Getting started

Installation

go get github.com/adrian-lin-1-0-0/simple

A Simple Example

package main

import (
	"log"

	"github.com/adrian-lin-1-0-0/simple"
)

func main() {
	r := simple.Default()
	r.Use(func(ctx *simple.Context) {
		println("middleware")
		ctx.Next()
	})

	r.GET("/hello", func(c *simple.Context) {
		c.HTML("<h1>Hello</h1>")
	})

	v1 := r.Group("/v1")
	v1.GET("/hello", func(c *simple.Context) {
		a := []int{1, 2, 3}
		//recovery
		println(a[3]) // panic: runtime error: index out of range [3] with length 3
		c.HTML("<h1>Hello v1</h1>")
	})

	v2 := r.Group("/v2")

	v2.GET("/hello", func(c *simple.Context) {

		c.HTML("<h1>Hello v2</h1>")
	})

	log.Fatal(
		r.Run(":8888", func() {
			println("Server is running on port http://localhost:8888")
		}),
	)
}

A Proxy Example

package main

import (
	"log"

	"github.com/adrian-lin-1-0-0/simple"
)

func main() {
	proxy := simple.DefaultProxy()
	proxy.GET("/api/v1", "http://localhost:8888/v1")
	proxy.GET("/api/v2", "http://localhost:8888/v2")

	log.Fatal(
		proxy.Run(":9999", func() {
			println("Server is running on port http://localhost:9999")
		}),
	)
}