golang轻量JSON API服务框架

golang轻量jsON API服务框架

A lightweight RESTful for Golang

Install

go get -u github.com/aixiaoxiang/bast

Router doc(Request example)

Router

Get

//Person struct type Person struct { Name string `json:"name"` Age int `json:"age"` Addr string `json:"addr"`} bast.Get("/xxx", func(ctx *bast.Context) { //verify imput parameter err := ctx.Verify("name@required|min:1", "age@required|min:1", "addr/address@required|min:1") if err != nil { ctx.Failed(err.Error()) return } name := ctx.GetString("name") age := ctx.GetInt("age") //handling //... person := &Person{ Name: name, Age: Age, } //translator address person.Addr = ctx.Trans("addr", person.Name) //handling //... ctx.JSON(person)})

Post

//Person structtype Person struct { Name string `json:"name" v:"required|min:1"` Age int `json:"age" v:"min:1"` Title string `json:"title"`}bast.Post("/xxx", func(ctx *bast.Context) { person := &Person{} err := ctx.JSONObj(person) //or ctx.JSONObj(person,true) //version of verify imput parameter if err != nil { ctx.Failed("sorry! invalid parameter") return } person.Age += 2 //translator title person.Title = ctx.Trans("title", person.Name) //handling //... ctx.JSON(person)})

For More

bast.Get(/* pattern string */, /* f func(ctx *Context) */)).Auth().Param("test xxx data")

Validate

a similar pipeline validator

Syntax

key[/key translator][/split divide (default is |)]@verify1[:verify1 param]|verify2

Syntax such as

key1@required|int|min:1 key2/key2_translator@required|string|min:1|max:12 key3@sometimes|required|date

Global register keys translator

note：only is key

//global register keys translator //note：only is keyfunc init() { //register keys translator //note：is key //suck as:verify error //en： The name field is required //zh-cn： {0} 不能空 lang.RegisterKeys("zh-cn", map[string]string{ "name": "姓名", "age": "年龄", "address": "地址", }) //other langs }

Support for the validator

note：will continue to add new validator

dateemailintipmatchmaxminrequiredsometimes

Http Client

httpc is HTTP client library

install

go get -u github.com/aixiaoxiang/bast/httpc

Support for GET POST HEAD POST PUT PATCH DELETE etc

result support string,json,xml,yaml,file etc

string result

result, err := httpc.Get("https://suggest.taobao.com/sug?code=utf-8&q=phone").String() if err != nil { //handling }

json result

type tb struct { Result [][]string `json:"result"` } rv := &tb{} err := httpc.Get("https://suggest.taobao.com/sug?code=utf-8").Param("q", "phone").ToJSON(rv) if err != nil { //handling }

xml result

type tb struct { Result [][]string `json:"result"` } rv := &tb{} err := httpc.Get("https://suggest.taobao.com/sug?code=utf-8").Param("q", "phone").ToXML(rv) if err != nil { //handling }

yaml result

type tb struct { Result [][]string `json:"result"` } rv := &tb{} err := httpc.Get("https://suggest.taobao.com/sug?code=utf-8").Param("q", "phone").ToYAML(rv) if err != nil { //handling }

save result to file

err := httpc.Post("https://suggest.taobao.com/sug?code=utf-8&q=phone").ToFile("./files/f.json") if err != nil { //handling }

upload file to server

result, err := httpc.Post("https://suggest.taobao.com/sug?code=utf-8&q=phone").File("testFile", "./files/f.json").String() if err != nil { //handling }

mark tag and hook's

result, err := httpc.Post("https://suggest.taobao.com/sug?code=utf-8&q=phone").MarkTag("ai").String() if err != nil { //handling }

Global register hook Before and After

func init() { httpc.Before(func(c *httpc.Client) error { if c.Tag == "ai" { c.Header("xxxx-test-header", "httpc") } else { //others handling } return nil }) httpc.After(func(c *httpc.Client) { if c.Tag == "ai" && c.OK() { //log.. } else { //others handling } })}

Run

bast.Run(":9999")

CommandLine

like nginx commandline

If Your program name is Ai

-h | --help

./Ai -h

--start

Run in background

./Ai --start

--stop

stop program

./Ai --stop

--reload

graceful restart. stop and start

./Ai --reload

--conf

seting config files.(default is ./config.conf)

./Ai --conf=your path/config.conf

--install

installed as service.(daemon)

./Ai --install

--uninstall

uninstall a service.(daemon)

./Ai --uninstall

--migration

migration or initial system(handle sql script ...)

./Ai --migration

Such as

run program (run in background)

./Ai --start --conf=./config.conf

deploy program (startup)

./Ai --install

config template

support multiple instances

[ {//a instance "key":"xxx-conf", "name":"xx", "addr":":9999", "fileDir":"./file/",//(default is ./file/) "debug":false, "baseUrl":"", "idNode":0, "lang":"en",//default lang en,zh-cn "trans":"",//translator files or dir "sameSite":"none",//cookie sameSite strict、lax、none "wrap":true,//wrap response body "session":{//session conf "enable":false, "lifeTime":20, "name":"_sid",//session name "prefix":"",//session id prefix "suffix":"",//session id suffix "engine":"memory",//session engine memory、redis、redis-cluster "source":"cookie",//cookie、header "sessionLock":false,///each session a lock(default is false) "redis":{//if source eq redis or redis-cluster "addrs":"ip:port,ip2:port2", "password":"", "poolSize":0 } }, "log":{ "outPath":"./logs/logs.log", //(default is ./logs/logs.log) "level":"debug", "maxSize":10, "maxBackups":3, "maxAge":28, "debug":false, "logSelect":false }, "cors":{//CORS https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Access_control_CORS "allowOrigin":"", "allowMethods":"GET, POST, OPTIONS, PATCH, PUT, DELETE, HEAD,UPDATE", "allowHeaders":"", "maxAge":"1728000", "allowCredentials":"true" }, "page":{ "page":"page name", "total":"total name", "pageRow":"pageRow name" }, "conf":{//user config(non bast framework) such as db config "key":"app", "name":"xxx", "dbTitle":"xxx app", "dbName":"xxxx db", "dbUser":"xxx", "dbPwd":"******", "dbServer":"localhost" //..more field..// }, "extend":""//user extend } //..more instances..//]

Distributed system unique ID

snowflake-golang or snowflake-twitter

use

id := bast.ID() fmt.Printf("id=%d", id)

benchmark test go test -bench=. -benchmem ./ids physics cpu 4

go test -bench=. -benchmem ./ids goos: darwin goarch: amd64 Benchmark_ID-4 20000000 72.1 ns/op 16 B/op 1 allocs/op Benchmark_Parallel_ID-4 10000000 150 ns/op 16 B/op 1 allocs/op PASS ok github.com/aixiaoxiang/bast/ids 10.126s

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。