https://github.com/issue9/web
通用的 web 框架
https://github.com/issue9/web
api api-framework api-server framework framework-go go golang server web web-framework
Last synced: 9 days ago
JSON representation
通用的 web 框架
- Host: GitHub
- URL: https://github.com/issue9/web
- Owner: issue9
- License: mit
- Created: 2015-06-28T14:25:28.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2026-03-30T04:24:09.000Z (19 days ago)
- Last Synced: 2026-03-30T06:46:15.481Z (18 days ago)
- Topics: api, api-framework, api-server, framework, framework-go, go, golang, server, web, web-framework
- Language: Go
- Homepage: https://pkg.go.dev/github.com/issue9/web
- Size: 4.38 MB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# web
[](https://github.com/issue9/web/actions/workflows/test.yml)
[](https://goreportcard.com/report/github.com/issue9/web)
[](https://codecov.io/gh/issue9/web)
[](https://pkg.go.dev/github.com/issue9/web)
web 是一个比较完整的 API 开发框架，相对于简单的路由，提供了更多的便利功能。
如果你只是需要一个简单的路由工具，那么你可以移步到 [mux](https://github.com/issue9/mux)。
```go
package main
import "github.com/issue9/web"
import "github.com/issue9/web/server"
// main.go
func main() {
srv, err := server.New("web", "1.0.0", &server.Options{})
router := srv.Routers().New()
router.Get("/admins", getAdmins).
Get("/groups", getGroups)
srv.Serve()
}
func getAdmins(ctx* web.Context) web.Responser {
return ctx.NotImplemented()
}
func getGroups(ctx* web.Context) web.Responser {
return ctx.NotImplemented()
}
```
## 字符集和文档类型
中列出的字符集都能自动转换。
文档类型由 `Server.Mimetypes` 指定。
```go
package main
import (
"github.com/issue9/web"
"github.com/issue9/web/server"
"github.com/issue9/web/mimetype/json"
"github.com/issue9/web/mimetype/xml"
)
srv := server.New("app", "1.0.0", &server.Options{
Codec: web.NewCodec().
AddMimetype(xml.Mimetype, json.Marshal, json.Unmarshal, xml.ProblemMimetype, true, true).
AddMimetype(xml.Mimetype, xml.Marshal, xml.Unmarshal, xml.ProblemMimetype, true, true)
}
})
srv.Serve()
```
客户端只要在请求时设置 Accept 报头就可返回相应类型的数据，而 Accept-Charset 报头可设置接收的字符集。
Content-Type 则可以有向服务器指定提交内容的文档类型和字符集。
## 错误处理
框架根据 [RFC7807](https://datatracker.ietf.org/doc/html/rfc7807) 提供了一种输出错误信息内容的机制。
在处理出错时，调用 Context.Problem 即可：
```go
func getAdmins(ctx* web.Context) web.Responser {
return ctx.Problem(web.ProblemBadRequest).WithParam("param", "invalid format")
}
```
## openapi
可直接在添加 API 的中间件上指定文档内容：
```go
srv := server.New("app", "1.0.0", ...)
router := s.Routers().New(...)
doc := openapi.New(srv, web.Phrase("title")) // 声明文档对象
router.Get("/users", doc.API(func(o* openapi.Operation){
o.Desc(web.Phrase("desc of api")). // 接口的描述
Body(). // 请求内容
Response() // 指定返回内容
}))
router.Get("/openapi", doc.Handler()) // 将文档以接口的形式输出
```
## 插件
- 提供了中间件、插件、过滤器等常用的功能。
## 工具
提供了一个简易的辅助工具。可以帮助用户完成以下工作：
- 提取和更新本地化信息；
- 热编译项目；
- 为枚举类型生成常用接口；
- 根据对象的注释生成 markdown 文档；
- 根据模板生成项目；
macOS 和 linux 用户可以直接使用 brew 进行安装：
```shell
brew tap caixw/brew
brew install caixw/brew/web
```
## 版权
本项目采用 [MIT](https://opensource.org/licenses/MIT) 开源授权许可证，完整的授权说明可在 [LICENSE](LICENSE) 文件中找到。