web

web 是一个比较完整的 API 开发框架，相对于简单的路由，提供了更多的便利功能。 如果你只是需要一个简单的路由工具，那么你可以移步到 mux。

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()
}

字符集和文档类型

https://www.iana.org/assignments/character-sets/character-sets.xhtml 中列出的字符集都能自动转换。 文档类型由 Server.Mimetypes 指定。

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).
        AddMimetype(xml.Mimetype, xml.Marshal, xml.Unmarshal, xml.ProblemMimetype)
    }
})

srv.Serve()

客户端只要在请求时设置 Accept 报头就可返回相应类型的数据，而 Accept-Charset 报头可设置接收的字符集。 Content-Type 则可以有向服务器指定提交内容的文档类型和字符集。

错误处理

框架根据 RFC7807 提供了一种输出错误信息内容的机制。

插件

• https://github.com/issue9/webuse 提供了常用的中间件和插件。
• https://github.com/issue9/webfilter 提供了常用的验证和修正数据的方法。

工具

https://github.com/issue9/web/releases 提供了一个简易的辅助工具。可以帮助用户完成以下工作：

• 提取和更新本地化信息；
• 生成 openapi 文档。需要在注释中写一定的注解；
• 热编译项目；

macOS 和 linux 用户可以直接使用 brew 进行安装：

brew tap caixw/brew
brew install caixw/brew/web

版权

本项目采用 MIT 开源授权许可证，完整的授权说明可在 LICENSE 文件中找到。