Fetch the repository succeeded.
This action will force synchronization from andeyalee/faygo, which will overwrite any changes that you have made since you forked the repository, and can not be recovered!!!
Synchronous operation will process in the background and will refresh the page when finishing processing. Please be patient.
Faygo is a fast and concise Go Web framework that can be used to develop high-performance web app(especially API) with fewer codes. Just define a struct Handler, Faygo will automatically bind/verify the request parameters and generate the online API doc. Go to <User Manual>
v1.1
Go Version ≥1.8
go get -u -v github.com/henrylee2cn/faygo
go get -u -v github.com/henrylee2cn/fay
fay command [arguments]
The commands are:
new create, compile and run (monitor changes) a new faygo project
run compile and run (monitor changes) an any existing go project
fay new appname [apptpl]
appname specifies the path of the new faygo project
apptpl optionally, specifies the faygo project template type
fay run [appname]
appname optionally, specifies the path of the new project
struct Handler can get more things:func or struct), which together constitute the handler chain of the router.| Network types | Configuration net_types
|
|---|---|
| HTTP | http |
| HTTPS/HTTP2(TLS) | https |
| HTTPS/HTTP2(Let's Encrypt TLS) | letsencrypt |
| HTTPS/HTTP2(Let's Encrypt TLS on UNIX socket) | unix_letsencrypt |
| HTTP(UNIX socket) | unix_http |
| HTTPS/HTTP2(TLS on UNIX socket) | unix_https |
httprouter supports both chain and tree registration styles; supports flexible static file router (such as DirFS, RenderFS, MarkdownFS, etc.).pongo2 as the HTML rendering engine.gorm, xorm, sqlx, directSQL, Websocket, ini, http client and many other commonly used expansion packages.
package main
import (
// "mime/multipart"
"time"
"github.com/henrylee2cn/faygo"
)
type Index struct {
Id int `param:"<in:path> <required> <desc:ID> <range: 0:10>"`
Title string `param:"<in:query> <nonzero>"`
Paragraph []string `param:"<in:query> <name:p> <len: 1:10> <regexp: ^[\\w]*$>"`
Cookie string `param:"<in:cookie> <name:faygoID>"`
// Picture *multipart.FileHeader `param:"<in:formData> <name:pic> <maxmb:30>"`
}
func (i *Index) Serve(ctx *faygo.Context) error {
if ctx.CookieParam("faygoID") == "" {
ctx.SetCookie("faygoID", time.Now().String())
}
return ctx.JSON(200, i)
}
func main() {
app := faygo.New("myapp", "0.1")
// Register the route in a chain style
app.GET("/index/:id", new(Index))
// Register the route in a tree style
// app.Route(
// app.NewGET("/index/:id", new(Index)),
// )
// Start the service
faygo.Run()
}
/*
http GET:
http://localhost:8080/index/1?title=test&p=abc&p=xyz
response:
{
"Id": 1,
"Title": "test",
"Paragraph": [
"abc",
"xyz"
],
"Cookie": "2016-11-13 01:14:40.9038005 +0800 CST"
}
*/
Handler and middleware are the same, both implemente Handler interface!
// Page handler doesn't contains API doc description
func Page() faygo.HandlerFunc {
return func(ctx *faygo.Context) error {
return ctx.String(200, "faygo")
}
}
// Page2 handler contains API doc description
var Page2 = faygo.WrapDoc(Page(), "test page2 notes", "test")
// Param binds and validates the request parameters by Tags
type Param struct {
Id int `param:"<in:path> <required> <desc:ID> <range: 0:10>"`
Title string `param:"<in:query>"`
}
// Serve implemente Handler interface
func (p *Param) Serve(ctx *faygo.Context) error {
return ctx.JSON(200,
faygo.Map{
"Struct Params": p,
"Additional Param": ctx.PathParam("additional"),
}, true)
}
// Doc implemente API Doc interface (optional)
func (p *Param) Doc() faygo.Doc {
return faygo.Doc{
// Add the API notes to the API doc
Note: "param desc",
// declare the response content format to the API doc
Return: faygo.JSONMsg{
Code: 1,
Info: "success",
},
// additional request parameter declarations to the API doc (optional)
Params: []faygo.ParamInfo{
{
Name: "additional",
In: "path",
Model: "a",
Desc: "defined by the `Doc()` method",
},
},
}
}
The filter function must be HandleFunc type!
func Root2Index(ctx *faygo.Context) error {
// Direct access to `/index` is not allowed
if ctx.Path() == "/index" {
ctx.Stop()
return nil
}
if ctx.Path() == "/" {
ctx.ModifyPath("/index")
}
return nil
}
// New application object, params: name, version
var app1 = faygo.New("myapp1", "1.0")
// router
app1.Filter(Root2Index).
Route(
app1.NewNamedGET("test page", "/page", Page()),
app1.NewNamedGET("test page2", "/page2", Page2),
app1.NewGroup("home",
app1.NewNamedGET("test param", "/param", &Param{
// sets the default value in the API documentation for the request parameters (optional)
Id: 1,
Title: "test param",
}),
),
)
// New application object, params: name, version
var app2 = faygo.New("myapp2", "1.0")
// router
app2.Filter(Root2Index)
app2.NamedGET("test page", "/page", Page())
app2.NamedGET("test page2", "/page2", Page2)
app2.Group("home")
{
app2.NamedGET("test param", "/param", &Param{
// sets the default value in the API documentation for the request parameters(optional)
Id: 1,
Title: "test param",
})
}
kill [pid]
kill -USR2 [pid]
config/{appname}[_{version}].ini). Refer to the following:net_types = http|https # List of network type: http | https | unix_http | unix_https | letsencrypt | unix_letsencrypt
addrs = 0.0.0.0:80|0.0.0.0:443 # List of multiple listening addresses
tls_certfile = # TLS certificate file path
tls_keyfile = # TLS key file path
letsencrypt_dir = # Let's Encrypt TLS certificate cache directory
unix_filemode = 0666 # File permissions for UNIX listener, requires octal number
read_timeout = 0s # Maximum duration for reading the full; ns|µs|ms|s|m|h request (including body)
write_timeout = 0s # Maximum duration for writing the full; ns|µs|ms|s|m|h response (including body)
multipart_maxmemory_mb = 32 # Maximum size of memory that can be used when receiving uploaded files
slow_response_threshold= 0s # When response time > slow_response_threshold, log level = 'WARNING'; 0 means not limited; ns|µs|ms|s|m|h
print_body = false # Form requests are printed in JSON format, but other types are printed as-is
[router] # Routing config section
redirect_trailing_slash = true # Automatic redirection (for example, `/foo/` -> `/foo`)
redirect_fixed_path = true # Tries to fix the current request path, if no handle is registered for it
handle_method_not_allowed = true # Returns 405 if the requested method does not exist, otherwise returns 404
handle_options = true # Automatic response OPTIONS request, you can set the default Handler in Faygo
default_upload = true # Automatically register the default router: /upload/*filepath
default_static = true # Automatically register the default router: /static/*filepath
[xsrf] # XSRF security section
enable = false # Whether enabled or not
key = faygoxsrf # Encryption key
expire_second = 3600 # Expire of XSRF token
[session] # Session section
enable = false # Whether enabled or not
provider = memory # Data storage
name = faygosessionID # The client stores the name of the cookie
provider_config = # According to the different engine settings different config information
cookie_life_second = 0 # The default value is 0, which is the lifetime of the browser
gc_life_second = 300 # The interval between triggering the GC
max_life_second = 3600 # The session max lefetime
auto_setcookie = true # Automatically set on the session cookie value, the general default true
domain = # The domain name that is allowed to access this cookie
enable_sid_in_header = false # Whether to write a session ID to the header
name_in_header = Faygosessionid # The name of the header when the session ID is written to the header
enable_sid_in_urlquery = false # Whether to write the session ID to the URL Query params
[apidoc] # API documentation section
enable = true # Whether enabled or not
path = /apidoc # The URL path
nolimit = false # If true, access is not restricted
real_ip = false # If true, means verifying the real IP of the visitor
whitelist = 192.*|202.122.246.170 # `whitelist=192.*|202.122.246.170` means: only IP addresses that are prefixed with `192.` or equal to `202.122.246.170` are allowed
desc = # Description of the application
email = # Technician's Email
terms_url = # Terms of service
license = # The license used by the API
license_url = # The URL of the protocol content page
config/__global__.ini). Refer to the following:[cache] # Cache section
enable = false # Whether enabled or not
size_mb = 32 # Max size by MB for file cache, the cache size will be set to 512KB at minimum.
expire_second = 60 # Maximum duration for caching
[gzip] # compression section
enable = false # Whether enabled or not
min_length = 20 # The minimum length of content to be compressed
compress_level = 1 # Non-file response Body's compression level is 0-9, but the files' always 9
methods = GET # List of HTTP methods to compress. If not set, only GET requests are compressed.
[log] # Log section
console_enable = true # Whether enabled or not console logger
console_level = debug # Console logger level: critical | error | warning | notice | info | debug
file_enable = true # Whether enabled or not file logger
file_level = debug # File logger level: critical | error | warning | notice | info | debug
async_len = 0 # The length of asynchronous buffer, 0 means synchronization
| tag | key | required | value | desc |
|---|---|---|---|---|
| param | in | only one | path | (position of param) if required is unsetted, auto set it. e.g. url: "http://www.abc.com/a/{path}" |
| param | in | only one | query | (position of param) e.g. url: "http://www.abc.com/a?b={query}" |
| param | in | only one | formData | (position of param) e.g. "request body: a=123&b={formData}" |
| param | in | only one | body | (position of param) request body can be any content |
| param | in | only one | header | (position of param) request header info |
| param | in | only one | cookie | (position of param) request cookie info, support: *http.Cookie,http.Cookie,string,[]byte
|
| param | name | no | (e.g.id) |
specify request param`s name |
| param | required | no | request param is required | |
| param | desc | no | (e.g.id) |
request param description |
| param | len | no | (e.g.3:6 3) |
length range of param's value |
| param | range | no | (e.g.0:10) |
numerical range of param's value |
| param | nonzero | no | param`s value can not be zero | |
| param | maxmb | no | (e.g.32) |
when request Content-Type is multipart/form-data, the max memory for body.(multi-param, whichever is greater) |
| param | regexp | no | (e.g.^\\w+$) |
verify the value of the param with a regular expression(param value can not be null) |
| param | err | no | (e.g.incorrect password format) |
the custom error for binding or validating |
NOTES:
*multipart.FileHeader, the binding struct's field can not be a pointerparam tag is not exist, anonymous field will be parsedin) is formData and the field's type is *multipart.FileHeader, multipart.FileHeader, []*multipart.FileHeader or []multipart.FileHeader, the param receives file uploadedin) is cookie, field's type must be *http.Cookie or http.Cookie
in(formData) and in(body) can not exist at the same timein(body) param tag| base | slice | special |
|---|---|---|
| string | []string | [][]byte |
| byte | []byte | [][]uint8 |
| uint8 | []uint8 | *multipart.FileHeader (only for formData param) |
| bool | []bool | []*multipart.FileHeader (only for formData param) |
| int | []int | *http.Cookie (only for net/http's cookie param) |
| int8 | []int8 | http.Cookie (only for net/http's cookie param) |
| int16 | []int16 | struct (struct type only for body param or as an anonymous field to extend params) |
| int32 | []int32 | |
| int64 | []int64 | |
| uint8 | []uint8 | |
| uint16 | []uint16 | |
| uint32 | []uint32 | |
| uint64 | []uint64 | |
| float32 | []float32 | |
| float64 | []float64 |
| package summary | import path |
|---|---|
| barcode | github.com/henrylee2cn/faygo/ext/barcode |
| Bit unit conversion | github.com/henrylee2cn/faygo/ext/bitconv |
| gorm(DB ORM) | github.com/henrylee2cn/faygo/ext/db/gorm |
| sqlx(DB ext) | github.com/henrylee2cn/faygo/ext/db/sqlx |
| xorm(DB ORM) | github.com/henrylee2cn/faygo/ext/db/xorm |
| directSQL(Configured SQL engine) | github.com/henrylee2cn/faygo/ext/db/directsql |
| One-time Password | github.com/henrylee2cn/faygo/ext/otp |
| UUID | github.com/henrylee2cn/faygo/ext/uuid |
| Websocket | github.com/henrylee2cn/faygo/ext/websocket |
| ini | github.com/henrylee2cn/faygo/ini |
| cron | github.com/henrylee2cn/faygo/ext/cron |
| task | github.com/henrylee2cn/faygo/ext/task |
| http client | github.com/henrylee2cn/faygo/ext/surfer |
| Product Name | Web/App Server | Home Page |
|---|---|---|
| 盯房 | App | https://www.df-house.com |
| eTrade | App | https://fir.im/ejy |
| Seven A Jewelry | Web | http://sevenajewelry.com |
| OneFor | App | https://fir.im/eqb |
| 杰运好车 | App | https://www.jieyunhaoche.com/appdown |
Note: Sorted in alphabetical order
Faygo is under Apache v2 License. See the LICENSE file for the full license text
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。