web

README

web

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

package main

import "github.com/issue9/web"

// main.go
func main() {
    srv, _ := web.NewServer("web", "1.0.0", &web.Options{})

    m1.Module(srv.NewModule("m1"))
    m2.Module(srv.NewModule("m2"))

    srv.Serve()
}

// modules/m1/module.go
func Module(m *web.Module) error {
    m.Action("serve").AddRoutes(func(r*web.Router){
        r.Get("/admins", getAdmins).
            Get("/groups", getGroups)
    })
}

// modules/m2/module.go
func Module(m *web.Module) error {
    m.Action("serve").AddRoutes(func(r*web.Router){
        r.Get("/admins", getAdmins).
            Get("/groups", getGroups)
    })
}

字符集和文档类型

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

import "github.com/issue9/web"

srv := web.NewServer(&web.Options{})

srv.Mimetypes().Add("application/json", json.Marshal, json.Unmarshal)
srv.Mimetypes().Add("application/xml", xml.Marshal, xml.Unmarshal)

srv.Serve()

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

错误处理

框架提供了一种输出错误信息内容的机制，用户只需要实现 Result 接口，即可自定义输出的错误信息格式。 具体实现可参考 server.defaultResult 的实现。

版权

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

Documentation

Overview

Package web 一个微型的 web 框架

Index

• Constants
• type Context
• type HandlerFunc
• type LocaleStringer
  • func Phrase(key string, v ...any) LocaleStringer
• type Middleware
• type MiddlewareFunc
• type Module
• type Options
• type Result
• type ResultFields
• type Router
• type RouterOptions
• type Server
  • func NewServer(name, version string, o *Options) (*Server, error)

Constants

const Version = "0.50.0"

Version 当前框架的版本

Types

type Context

type Context = server.Context

type HandlerFunc

type HandlerFunc = server.HandlerFunc

type LocaleStringer

type LocaleStringer = localeutil.LocaleStringer

LocaleStringer 本地化字符串需要实在的接口

部分 error 返回可能也实现了该接口。

func Phrase

func Phrase(key string, v ...any) LocaleStringer

Phrase 生成本地化的语言片段

type Middleware

type Middleware = server.Middleware

type MiddlewareFunc

type MiddlewareFunc = server.MiddlewareFunc

type Module

type Module = server.Module

type Options

type Options = server.Options

type Result

type Result = server.Result

type ResultFields

type ResultFields = server.ResultFields

type Router

type Router = server.Router

type RouterOptions

type RouterOptions = server.RouterOptions

type Server

type Server = server.Server

func NewServer

func NewServer(name, version string, o *Options) (*Server, error)

NewServer 从 Options 初始化 Server 对象