whs

README

web http(s) service
markdown »

Demo · Bug · Issues

English | 中文

Guide

1. create server

s := New("127.0.0.1", 80)

1. routes

s.RegisterRouter("/user", func(c *Context) {
c.ResponseWriter.Write([]byte("/user"))
}

1. route group

home := s.Group("/home")
{
    home.RegisterRouter("/index", func(c *Context) { c.ResponseWriter.Write([]byte("/home/index")) })
}}
)

1. middleware

home.UseMiddleware(func(c *Context) {
c.ResponseWriter.Write([]byte("2"))
c.Next()
c.ResponseWriter.Write([]byte("2"))
})

1. template

s.Static("static/", "/static")
s.Func(template.FuncMap{"FormatTime": FormatTime})
s.Template("template/*")```
6. start and stop 
```text
s.Start()
s.stop()

Pre development Configuration Requirements

1. go version 1.21.1

Installation

1. go get github.com/learnselfs/wlog github.com/learnselfs/wlog

Contributor

Please read CONTABUTING.md to find out the developers who have contributed to this project.

Open Source Projects

Contributing makes the open source community an excellent place to learn, motivate, and create. Any contribution you make is greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

This project has signed an Apache license, please refer to for details. LICENSE

Thanks

• gin
• Best_README_template
• Choose an Open Source License
• GitHub Pages

Documentation

Overview

Package whs @Author Bing @Date 2024/2/27 10:44:00 @Desc

Package whs @Author Bing @Date 2024/2/3 21:01:00 @Desc

Package whs @Author Bing @Date 2024/2/3 20:11:00 @Desc

Package whs @Author Bing @Date 2024/2/2 17:07:00 @Desc

Package whs @Author Bing @Date 2024/2/4 20:58:00 @Desc

Package whs @Author Bing @Date 2024/2/3 20:37:00 @Desc

Package whs @Author Bing @Date 2024/2/3 20:11:00 @Desc

Package whs @Author Bing @Date 2024/2/10 20:46:00 @Desc

Package whs @Author Bing @Date 2024/2/3 22:00:00 @Desc

Index

• func ErrorHandler(c *Context, status int, err error)
• func NotFoundHandler(c *Context)
• type Context
  • func NewContent(r *http.Request, w http.ResponseWriter) *Context
  • func (c *Context) Html(state int, tmpl string, data map[string]any)
  • func (c *Context) Json(state int, data any, msg string)
  • func (c *Context) Next()
• type Handler
• type IRoute
• type IService
• type Message
• type Route
  • func (r *Route) DELETE(url string, handler Handler)
  • func (r *Route) GET(url string, handler Handler)
  • func (r *Route) Group(prefix string) *Route
  • func (r *Route) POST(url string, handler Handler)
  • func (r *Route) PUT(url string, handler Handler)
  • func (r *Route) RegisterRouter(method, url string, handler Handler)
  • func (r *Route) Router(method, url string) *Route
  • func (r *Route) UseMiddleware(middleware Handler)
• type Service
  • func New(host string, port int) *Service
  • func (s *Service) Func(fun template.FuncMap)
  • func (s *Service) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *Service) Start()
  • func (s *Service) Static(url, path string)
  • func (s *Service) Stop()
  • func (s *Service) Template(webPah string)
  • func (s *Service) TemplateDelim(left, right, webPah string)

Functions

func ErrorHandler

func ErrorHandler(c *Context, status int, err error)

func NotFoundHandler

func NotFoundHandler(c *Context)

Types

type Context

type Context struct {
	// request
	*http.Request

	// response
	http.ResponseWriter
	// contains filtered or unexported fields
}

Context for encapsulating request data and processing responses

func NewContent

func NewContent(r *http.Request, w http.ResponseWriter) *Context

NewContent returns a new Context

func (*Context) Html

func (c *Context) Html(state int, tmpl string, data map[string]any)

func (*Context) Json

func (c *Context) Json(state int, data any, msg string)

func (*Context) Next

func (c *Context) Next()

Next complete middleware

type Handler

type Handler func(ctx *Context)

type IRoute

type IRoute interface {
}

IRoute interface

type IService

type IService interface {
}

IService interface：

type Message

type Message struct {
	Code int    `json:"code"`
	Data any    `json:"data"`
	Msg  string `json:"msg"`
}

type Route

type Route struct {
	// contains filtered or unexported fields
}

Route struct

func (*Route) DELETE

func (r *Route) DELETE(url string, handler Handler)

func (*Route) GET

func (r *Route) GET(url string, handler Handler)

func (*Route) Group

func (r *Route) Group(prefix string) *Route

Group route

func (*Route) POST

func (r *Route) POST(url string, handler Handler)

func (*Route) PUT

func (r *Route) PUT(url string, handler Handler)

func (*Route) RegisterRouter

func (r *Route) RegisterRouter(method, url string, handler Handler)

RegisterRouter for add router

func (*Route) Router

func (r *Route) Router(method, url string) *Route

func (*Route) UseMiddleware

func (r *Route) UseMiddleware(middleware Handler)

UseMiddleware complete

type Service

type Service struct {
	*Route
	*http.Server
	// contains filtered or unexported fields
}

Service struct

func New

func New(host string, port int) *Service

New function return http server

func (*Service) Func

func (s *Service) Func(fun template.FuncMap)

func (*Service) ServeHTTP

func (s *Service) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP for main processing function

func (*Service) Start

func (s *Service) Start()

Start for http server

func (*Service) Static

func (s *Service) Static(url, path string)

func (*Service) Stop

func (s *Service) Stop()

Stop for http server

func (*Service) Template

func (s *Service) Template(webPah string)

func (*Service) TemplateDelim

func (s *Service) TemplateDelim(left, right, webPah string)