README
¶
yap - Yet Another Go/Go+ HTTP Web Framework
How to use in Go+
This repo contains two Go+ classfiles: yap (a HTTP Web Framework) and yaptest (a HTTP Test Framework).
The classfile yap has the file suffix _yap.gox. And the classfile yaptest has the file suffix _ytest.gox.
Before using yap or yaptest, you need to add github.com/goplus/yap to go.mod by using go get:
go get github.com/goplus/yap@latest
Then find require github.com/goplus/yap statement in go.mod and add //gop:class at the end of the line:
require github.com/goplus/yap v0.7.2 //gop:class
Router and Parameters
demo in Go (hello.go):
import "github.com/goplus/yap"
y := yap.New()
y.GET("/p/:id", func(ctx *yap.Context) {
ctx.JSON(200, yap.H{
"id": ctx.Param("id"),
})
})
y.Handle("/", func(ctx *yap.Context) {
ctx.TEXT(200, "text/html", `<html><body>Hello, <a href="/p/123">Yap</a>!</body></html>`)
})
y.Run(":8080")
demo in Go+ classfile (hello_yap.gox):
get "/p/:id", ctx => {
ctx.json {
"id": ctx.param("id"),
}
}
handle "/", ctx => {
ctx.html `<html><body>Hello, <a href="/p/123">Yap</a>!</body></html>`
}
run ":8080"
Static files
Static files server demo in Go:
y := yap.New(os.DirFS("."))
y.Static("/foo", y.FS("public"))
y.Static("/") // means: y.Static("/", y.FS("static"))
y.Run(":8888")
Static files server demo in Go+ classfile (staticfile_yap.gox):
static "/foo", FS("public")
static "/"
run ":8888"
Static files server also can use a http.FileSystem instead of fs.FS object (See yapserve for details):
import "github.com/qiniu/x/http/fs"
static "/", fs.http("https://goplus.org"), false // false means not allow to redirect
run ":8888"
YAP Template
demo in Go (blog.go, article_yap.html):
import (
"os"
"github.com/goplus/yap"
)
y := yap.New(os.DirFS("."))
y.GET("/p/:id", func(ctx *yap.Context) {
ctx.YAP(200, "article", yap.H{
"id": ctx.Param("id"),
})
})
y.Run(":8080")
demo in Go+ classfile (blog_yap.gox, article_yap.html):
get "/p/:id", ctx => {
ctx.yap "article", {
"id": ctx.param("id"),
}
}
run ":8080"
YAP Test Framework
Suppose we have a web server named foo (demo/foo/foo_yap.gox):
get "/p/:id", ctx => {
ctx.json {
"id": ctx.param("id"),
}
}
run ":8080"
Then we create a yaptest file (demo/foo/foo_ytest.gox):
mock "foo.com", new(foo)
run "test get /p/$id", => {
id := "123"
get "http://foo.com/p/${id}"
ret 200
json {
"id": id,
}
}
The directive mock creates the foo server by mockhttp. Then we call the directive run to run a subtest.
You can change the directive mock to testServer (see demo/foo/bar_ytest.gox), and keep everything else unchanged:
testServer "foo.com", new(foo)
run "test get /p/$id", => {
id := "123"
get "http://foo.com/p/${id}"
ret 200
json {
"id": id,
}
}
The directive testServer creates the foo server by net/http/httptest and obtained a random port as the service address. Then it calls the directive host to map the random service address to foo.com. This makes all other code no need to changed.
For more details, see yaptest - Go+ HTTP Test Framework.
Documentation
¶
Index ¶
- Constants
- func Gopt_App_Main(app AppType)
- func SubFS(fsys fs.FS, dir string) (ret fs.FS)
- type App
- func (r *App) DELETE(path string, handle func(ctx *Context))
- func (r *App) GET(path string, handle func(ctx *Context))
- func (p *App) Get(path string, handle func(ctx *Context))
- func (r *App) HEAD(path string, handle func(ctx *Context))
- func (p *App) Head(path string, handle func(ctx *Context))
- func (r *App) OPTIONS(path string, handle func(ctx *Context))
- func (p *App) Options(path string, handle func(ctx *Context))
- func (r *App) PATCH(path string, handle func(ctx *Context))
- func (r *App) POST(path string, handle func(ctx *Context))
- func (r *App) PUT(path string, handle func(ctx *Context))
- func (p *App) Patch(path string, handle func(ctx *Context))
- func (p *App) Post(path string, handle func(ctx *Context))
- func (p *App) Put(path string, handle func(ctx *Context))
- func (r *App) Route(method, path string, handle func(ctx *Context))
- func (p *App) Static__0(pattern string, dir ...fs.FS)
- func (p *App) Static__1(pattern string, ctx context.Context, url string) (closer fsx.Closer, err error)
- func (p *App) Static__2(pattern string, fs http.FileSystem, allowRedirect ...bool)
- type AppType
- type Context
- func (p *Context) Accept(mime ...string) string
- func (p *Context) Binary__0(code int, mime string, data []byte)
- func (p *Context) Binary__1(code int, data []byte)
- func (p *Context) Binary__2(data []byte)
- func (p *Context) Binary__3(code int, data string)
- func (p *Context) Binary__4(data string)
- func (p *Context) DATA(code int, mime string, data []byte)
- func (p *Context) Html__0(code int, text string)
- func (p *Context) Html__1(text string)
- func (p *Context) Html__2(code int, text []byte)
- func (p *Context) Html__3(text []byte)
- func (p *Context) JSON(code int, data interface{})
- func (p *Context) Json__0(code int, data interface{})
- func (p *Context) Json__1(data interface{})
- func (p *Context) Param(name string) string
- func (p *Context) ParamInt(name string, defval int) int
- func (p *Context) PrettyJSON(code int, data interface{})
- func (p *Context) PrettyJson__0(code int, data interface{})
- func (p *Context) PrettyJson__1(data interface{})
- func (p *Context) Redirect(url string, code ...int)
- func (p *Context) TEXT(code int, mime string, text string)
- func (p *Context) Text__0(code int, mime string, text string)
- func (p *Context) Text__1(code int, text string)
- func (p *Context) Text__2(text string)
- func (p *Context) Text__3(code int, text []byte)
- func (p *Context) Text__4(text []byte)
- func (p *Context) YAP(code int, yapFile string, data interface{})
- func (p *Context) Yap__0(code int, yapFile string, data interface{})
- func (p *Context) Yap__1(yapFile string, data interface{})
- type Engine
- func (r *Engine) DELETE(path string, handle func(ctx *Context))
- func (p *Engine) FS(dir string) (ret fs.FS)
- func (r *Engine) GET(path string, handle func(ctx *Context))
- func (r *Engine) HEAD(path string, handle func(ctx *Context))
- func (p *Engine) Handle(pattern string, f func(ctx *Context))
- func (p *Engine) Handler(mws ...func(h http.Handler) http.Handler) http.Handler
- func (p *Engine) InitYap(fs ...fs.FS)
- func (p *Engine) NewContext(w http.ResponseWriter, r *http.Request) *Context
- func (r *Engine) OPTIONS(path string, handle func(ctx *Context))
- func (r *Engine) PATCH(path string, handle func(ctx *Context))
- func (r *Engine) POST(path string, handle func(ctx *Context))
- func (r *Engine) PUT(path string, handle func(ctx *Context))
- func (r *Engine) Route(method, path string, handle func(ctx *Context))
- func (p *Engine) Run(addr string, mws ...func(h http.Handler) http.Handler) error
- func (p *Engine) ServeHTTP(w http.ResponseWriter, req *http.Request)
- func (p *Engine) SetLAS(listenAndServe func(addr string, handler http.Handler) error)
- func (p *Engine) Static(pattern string, dir ...fs.FS)
- func (p *Engine) StaticHttp(pattern string, fsys http.FileSystem, allowRedirect ...bool)
- type H
- type Template
Constants ¶
const (
GopPackage = true
)
Variables ¶
This section is empty.
Functions ¶
func Gopt_App_Main ¶ added in v0.5.0
func Gopt_App_Main(app AppType)
Gopt_App_Main is required by Go+ compiler as the entry of a YAP project.
Types ¶
type App ¶ added in v0.5.0
type App struct {
Engine
}
func (*App) DELETE ¶ added in v0.5.0
DELETE is a shortcut for router.Route(http.MethodDelete, path, handle)
func (*App) HEAD ¶ added in v0.5.0
HEAD is a shortcut for router.Route(http.MethodHead, path, handle)
func (*App) Head ¶ added in v0.5.0
Head is a shortcut for router.Route(http.MethodHead, path, handle)
func (*App) OPTIONS ¶ added in v0.5.0
OPTIONS is a shortcut for router.Route(http.MethodOptions, path, handle)
func (*App) Options ¶ added in v0.5.0
Options is a shortcut for router.Route(http.MethodOptions, path, handle)
func (*App) PATCH ¶ added in v0.5.0
PATCH is a shortcut for router.Route(http.MethodPatch, path, handle)
func (*App) POST ¶ added in v0.5.0
POST is a shortcut for router.Route(http.MethodPost, path, handle)
func (*App) Patch ¶ added in v0.5.0
Patch is a shortcut for router.Route(http.MethodPatch, path, handle)
func (*App) Post ¶ added in v0.5.0
Post is a shortcut for router.Route(http.MethodPost, path, handle)
func (*App) Route ¶ added in v0.5.0
Route registers a new request handle with the given path and method.
For GET, POST, PUT, PATCH and DELETE requests the respective shortcut functions can be used.
This function is intended for bulk loading and to allow the usage of less frequently used, non-standardized or custom methods (e.g. for internal communication with a proxy).
func (*App) Static__0 ¶ added in v0.7.1
Static serves static files from a dir (default is "$YapFS/static").
type AppType ¶ added in v0.7.3
type AppType interface {
InitYap(fs ...fs.FS)
SetLAS(listenAndServe func(addr string, handler http.Handler) error)
}
AppType represents an abstract of YAP applications.
type Context ¶
type Context struct {
*http.Request
http.ResponseWriter
// contains filtered or unexported fields
}
func (*Context) Accept ¶
Accept header specifies: Accept: <MIME_type>/<MIME_subtype> Accept: <MIME_type>/* Accept: */* Multiple types, weighted with the quality value syntax: Accept: text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, */*;q=0.8 FIXME: 1. quality value not supported, 2. don't need parse all, just find the first match with a spliter iterator
func (*Context) PrettyJSON ¶
func (*Context) PrettyJson__0 ¶ added in v0.5.0
func (*Context) PrettyJson__1 ¶ added in v0.5.0
func (p *Context) PrettyJson__1(data interface{})
func (*Context) Redirect ¶ added in v0.7.0
Redirect replies to the request with a redirect to url, which may be a path relative to the request path.
type Engine ¶
func (*Engine) DELETE ¶ added in v0.2.0
DELETE is a shortcut for router.Route(http.MethodDelete, path, handle)
func (*Engine) GET ¶ added in v0.2.0
GET is a shortcut for router.Route(http.MethodGet, path, handle)
func (*Engine) HEAD ¶ added in v0.2.0
HEAD is a shortcut for router.Route(http.MethodHead, path, handle)
func (*Engine) Handler ¶ added in v0.7.3
Handler returns the main entry that responds to HTTP requests.
func (*Engine) NewContext ¶
func (*Engine) OPTIONS ¶ added in v0.2.0
OPTIONS is a shortcut for router.Route(http.MethodOptions, path, handle)
func (*Engine) PATCH ¶ added in v0.2.0
PATCH is a shortcut for router.Route(http.MethodPatch, path, handle)
func (*Engine) POST ¶ added in v0.2.0
POST is a shortcut for router.Route(http.MethodPost, path, handle)
func (*Engine) PUT ¶ added in v0.2.0
PUT is a shortcut for router.Route(http.MethodPut, path, handle)
func (*Engine) Route ¶ added in v0.2.0
Route registers a new request handle with the given path and method.
For GET, POST, PUT, PATCH and DELETE requests the respective shortcut functions can be used.
This function is intended for bulk loading and to allow the usage of less frequently used, non-standardized or custom methods (e.g. for internal communication with a proxy).
func (*Engine) Run ¶
Run listens on the TCP network address addr and then calls Serve with handler to handle requests on incoming connections. Accepted connections are configured to enable TCP keep-alives.
func (*Engine) ServeHTTP ¶ added in v0.2.0
func (p *Engine) ServeHTTP(w http.ResponseWriter, req *http.Request)
ServeHTTP makes the router implement the http.Handler interface.
func (*Engine) SetLAS ¶ added in v0.7.3
SetLAS sets listenAndServe func to listens on the TCP network address addr and to handle requests on incoming connections.
func (*Engine) Static ¶ added in v0.7.0
Static serves static files from a dir (default is "$YapFS/static").
func (*Engine) StaticHttp ¶ added in v0.7.1
func (p *Engine) StaticHttp(pattern string, fsys http.FileSystem, allowRedirect ...bool)
StaticHttp serves static files from fsys (http.FileSystem).
type Template ¶
Template is the representation of a parsed template. The *parse.Tree field is exported only for use by html/template and should be treated as unexported by all other clients.
func NewTemplate ¶
NewTemplate allocates a new, undefined template with the given name.
Source Files
Directories