https://github.com/goplus/yap
Yet Another Go/Go+ HTTP Web Framework
https://github.com/goplus/yap
Last synced: about 1 month ago
JSON representation
Yet Another Go/Go+ HTTP Web Framework
- Host: GitHub
- URL: https://github.com/goplus/yap
- Owner: goplus
- License: apache-2.0
- Created: 2023-12-27T15:25:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-15T14:02:05.000Z (about 1 year ago)
- Last Synced: 2024-04-20T09:16:05.346Z (about 1 year ago)
- Language: Go
- Size: 357 KB
- Stars: 18
- Watchers: 2
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
yap - Yet Another Go/Go+ HTTP Web Framework
======
[](https://github.com/goplus/yap/actions/workflows/go.yml)
[](https://goreportcard.com/report/github.com/goplus/yap)
[](https://github.com/goplus/yap/releases)
[](https://codecov.io/gh/goplus/yap)
[](https://pkg.go.dev/github.com/goplus/yap)
[](https://github.com/goplus/gop)
This repo contains three [Go+ classfiles](https://github.com/goplus/gop/blob/main/doc/classfile.md). They are [yap](#yap-http-web-framework) (a HTTP Web Framework), [yaptest](ytest) (a HTTP Test Framework) and [ydb](ydb) (a Go+ Database Framework).
The classfile [yap](#yap-http-web-framework) has the file suffix `.yap`. The classfile [yaptest](ytest) has the file suffix `_ytest.gox`. And the classfile [ydb](ydb) has the file suffix `_ydb.gox`.
Before using `yap`, `yaptest` or `ydb`, you need to add `github.com/goplus/yap` to `go.mod`:
```sh
gop get github.com/goplus/yap@latest
```
For more details, see [YAP Framework Manual](doc/manual.md).
### How to use in Go+
First let us initialize a hello project:
```sh
gop mod init hello
```
Then we have it reference a classfile called `yap` as the HTTP Web Framework:
```sh
gop get github.com/goplus/yap@latest
```
Create a file named [get.yap](demo/classfile2_hello/get.yap) with the following content:
```go
html `Hello, YAP!`
```
Execute the following commands:
```sh
gop mod tidy
gop run .
```
A simplest web program is running now. At this time, if you visit http://localhost:8080, you will get:
```
Hello, YAP!
```
### yap: HTTP Web Framework
This classfile has the file suffix `.yap`.
#### Router and Parameters
YAP uses filenames to define routes. `get.yap`'s route is `get "/"` (GET homepage), and `get_p_#id.yap`'s route is `get "/p/:id"` (In fact, the filename can also be `get_p_:id.yap`, but it is not recommended because `:` is not allowed to exist in filenames under Windows).
Let's create a file named [get_p_#id.yap](demo/classfile2_hello/get_p_%23id.yap) with the following content:
```coffee
json {
"id": ${id},
}
```
Execute `gop run .` and visit http://localhost:8080/p/123, you will get:
```
{"id": "123"}
```
#### YAP Template
In most cases, we don't use the `html` directive to generate html pages, but use the `yap` template engine. See [get_p_#id.yap](demo/classfile2_blog/get_p_%23id.yap):
```coffee
yap "article", {
"id": ${id},
}
```
It means finding a template called `article` to render. See [yap/article_yap.html](demo/classfile2_blog/yap/article_yap.html):
```html
Article {{.id}}
```
#### Run at specified address
By default the YAP server runs on `localhost:8080`, but you can change it in [main.yap](demo/classfile2_blog/main.yap) file:
```coffee
run ":8888"
```
#### Static files
Static files server demo ([main.yap](demo/classfile2_static/main.yap)):
```coffee
static "/foo", FS("public")
static "/"
run ":8080"
```
### yaptest: HTTP Test Framework
[yaptest](ytest) is a web server testing framework. This classfile has the file suffix `_ytest.gox`.
Suppose we have a web server ([foo/get_p_#id.yap](ytest/demo/foo/get_p_%23id.yap)):
```go
json {
"id": ${id},
}
```
Then we create a yaptest file ([foo/foo_ytest.gox](ytest/demo/foo/foo_ytest.gox)):
```go
mock "foo.com", new(AppV2) // name of any YAP v2 web server is `AppV2`
id := "123"
get "http://foo.com/p/${id}"
ret 200
json {
"id": id,
}
```
The directive `mock` creates the web server by [mockhttp](https://pkg.go.dev/github.com/qiniu/x/mockhttp). Then we write test code directly.
You can change the directive `mock` to `testServer` (see [foo/bar_ytest.gox](ytest/demo/foo/bar_ytest.gox)), and keep everything else unchanged:
```go
testServer "foo.com", new(AppV2)
id := "123"
get "http://foo.com/p/${id}"
ret 200
json {
"id": id,
}
```
The directive `testServer` creates the web server by [net/http/httptest](https://pkg.go.dev/net/http/httptest#NewServer) and obtained a random port as the service address. Then it calls the directive [host](https://pkg.go.dev/github.com/goplus/yap/ytest#App.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](ytest).
### ydb: Database Framework
This classfile has the file suffix `_ydb.gox`.
TODO