# Beerus

**Repository Path**: ivwsdnvpynn/Beerus

## Basic Information

- **Project Name**: Beerus
- **Description**:  logo设置完以后，麻烦从正文里面删除，谢谢 ----------------------- 正文只保留这条线以下的 ---------------------- Beerus 
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://www.oschina.net/p/beerus
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2021-12-14
- **Last Updated**: 2021-12-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1> 
    <a href="https://beeruscc.com">Beerus</a> ·
    <img src="https://img.shields.io/badge/licenes-MIT-brightgreen.svg"/> 
    <img src="https://img.shields.io/badge/golang-1.17.3-brightgreen.svg"/> 
    <img src="https://img.shields.io/badge/release-tags-brightgreen.svg"/>
</h1>

Beerus is a web framework developed entirely in go, 
Based on net/http, it extends the management of routes, adds interceptors, session management, 
receiving parameters with struct, parameter validation, etc. 
It also provides WebSocket support to upgrade the http protocol to WebSocket and implement communication.

## Installation

```shell
go get github.com/yuyenews/Beerus
```

## Documentation

[https://beeruscc.com/beerus](https://beeruscc.com/beerus)

## Examples

### HTTP example

Create a function to manage the routing configuration

```go
func CreateRoute() {
	// post route example
    route.POST("/example/post", func (req *commons.BeeRequest, res *commons.BeeResponse) {
        
        res.SendJson(`{"msg":"SUCCESS"}`)
    })

    // get route example
    route.GET("/example/get", func (req *commons.BeeRequest, res *commons.BeeResponse) {
    
        res.SendJson(`{"msg":"SUCCESS"}`)
    })
}
```

Start Service

```go
func main() {
    // Interceptors, routes, etc. Loading of data requires its own calls
    routes.CreateRoute()
    
    // Listen the service and listen to port 8080
    beerus.ListenHTTP(8080)
}
```

If you want to put the parameters inside struct and complete the parameter checks

```go
func CreateRoute() {
    // Example of parameter conversion to struct and parameter checksum
    route.POST("/example/post", func (req *commons.BeeRequest, res *commons.BeeResponse) {
        param := DemoParam{}
        
        // Extraction parameters, Generally used in scenarios where verification is not required or you want to verify manually
        params.ToStruct(req, &param, param)
        
        // Separate validation of data in struct, this feature can be used independently in any case and is not limited to the routing layer.
        var result = params.Validation(req, &param, param)
        if result != params.SUCCESS {
            res.SendErrorMsg(1128, result)
            return
        }
        
        // You can also convert + validate the parameters in one step
        // Extraction of parameters + validation
        var result = params.ToStructAndValidation(req, &param, param)
        if result != params.SUCCESS {
            res.SendErrorMsg(1128, result)
            return
        }
        
        
        res.SendJson(`{"msg":"SUCCESS"}`)
    })
}

// DemoParam If you have a struct like this, and you want to put all the parameters from the request into this struct
type DemoParam struct {
    // You can customize any field
    // the name of the field must be exactly the same as the name of the requested parameter, and is case-sensitive
    TestStringReception  string  `notnull:"true" msg:"TestStringReception Cannot be empty" routes:"/example/put"`
    TestIntReception     int     `max:"123" min:"32" msg:"TestIntReception The value range must be between 32 - 123" routes:"/example/post"`
    TestUintReception    uint    `max:"123" min:"32" msg:"TestUintReception The value range must be between 32 - 123"`
    TestFloatReception   float32 `max:"123" min:"32" msg:"TestFloatReception The value range must be between 32 - 123"`
    TestBoolReception    bool
    TestStringRegReception string `reg:"^[a-z]+$" msg:"TestStringRegReception Does not meet the regular"`
    TestBeeFileReception commons.BeeFile
    
    TestJsonReception []string
}
```

### WebSocket example

CreateWebSocketRoute Creating websocket routes

```go
func CreateWebSocketRoute() {
	wroute.AddWebSocketRoute("/ws/test", onConnection, onMessage, onClose)
	wroute.AddWebSocketRoute("/ws/test2", onConnection, onMessage, onClose)
}

// In order to save time, only three functions are used below. In practice, you can configure a set of functions for each wroute

func onConnection(session *wparams.WebSocketSession, msg string) {
	session.SendString("connection success")
}

func onMessage(session *wparams.WebSocketSession, msg string) {
	session.SendString("I got the message.")
}

func onClose(session *wparams.WebSocketSession, msg string) {
    println(msg + "-------------------------------")
}
```

Start Service

```go
func main() {
    // Interceptors, routes, etc. Loading of data requires its own calls
    routes.CreateRoute()
    routes.CreateWebSocketRoute()
    
    // Listen the service and listen to port 8080
    beerus.ListenHTTP(8080)
}
```

[Complete sample code](https://github.com/yuyenews/Beerus/tree/master/example)

## License

Beerus is [MIT licensed](https://github.com/yuyenews/Beerus/blob/master/LICENSE)