webapi

README

webapi 概述

包："github.com/farseer-go/webapi"

模块：webapi.Module

• 文档（国内）
• 文档（国外）
• 开源（Github）

用于快速构建api服务，带来极简、优雅的开发体验。编写api服务时，不需要使用httpRequest、httpResponse等数据结构。

webapi使用了中间件的管道模型编写，让我们加入非业务逻辑时非常简单。

包含两种风格来提供API服务：

• MinimalApi：动态API风格（直接绑定到逻辑层）
• Mvc：Controller、Action风格

使用minimalApi时，甚至不需要UI层来提供API服务。

webapi有哪些功能

• 支持中间件
• 入参、出参隐式绑定
• 支持静态目录绑定
• ActionFilter过虑器
• ActionResult抽象结果
• Area区域设置
• MinimalApi模式
• Mvc模式
  • HttpContext上下文
  • Header隐式绑定

大部份情况下，除了main需要配置webapi路由外，在你的api handle中就是一个普通的func函数，不需要依赖webapi组件。webapi会根据func函数的出入参来隐式绑定数据。

func main() {
	fs.Initialize[webapi.Module]("FOPS")
	webapi.RegisterPOST("/mini/hello1", Hello1)
	webapi.RegisterPOST("/mini/hello3", Hello3, "pageSize", "pageIndex")
	webapi.Run()
}

// 使用结构（DTO）来接收入参
// 返回string
func Hello1(req pageSizeRequest) string {
	return fmt.Sprintf("hello world pageSize=%d，pageIndex=%d", req.PageSize, req.PageIndex)
}

// 使用基础参数来接收入参
// 返回pageSizeRequest结构（会自动转成json)
func Hello3(pageSize int, pageIndex int) pageSizeRequest {
    return pageSizeRequest{
        PageSize:  pageSize,
        PageIndex: pageIndex,
    }
}

// 也可以定义一个结构，用于接收参数
type pageSizeRequest struct {
    PageSize  int
    PageIndex int
}

函数中，出入参都会自动绑定数据

如果是application/json，则会自动被反序列化成model，如果是x-www-form-urlencoded，则会将每一项的key/value匹配到model字段中

可以看到，整个过程，不需要做json序列化、httpRequest、httpResponse的操作。

Documentation

Index

• func Area(area string, f func())
• func RegisterController(c controller.IController)
• func RegisterDELETE(route string, actionFunc any, params ...string)
• func RegisterGET(route string, actionFunc any, params ...string)
• func RegisterMiddleware(m middleware.IMiddleware)
• func RegisterPOST(route string, actionFunc any, params ...string)
• func RegisterPUT(route string, actionFunc any, params ...string)
• func RegisterRoutes(routes []Route)
• func Run(params ...string)
• func UseApiResponse()
• func UseCors()
• func UseStaticFiles()
• func UseWebApi()
• type Module
  • func (module Module) DependsModule() []modules.FarseerModule
  • func (module Module) Initialize()
  • func (module Module) PostInitialize()
  • func (module Module) PreInitialize()
  • func (module Module) Shutdown()
• type Route

Functions

func Area

func Area(area string, f func())

Area 设置区域

func RegisterController

func RegisterController(c controller.IController)

RegisterController 自动注册控制器下的所有Action方法

func RegisterDELETE

func RegisterDELETE(route string, actionFunc any, params ...string)

RegisterDELETE 注册单个Api

func RegisterGET

func RegisterGET(route string, actionFunc any, params ...string)

RegisterGET 注册单个Api

func RegisterMiddleware

func RegisterMiddleware(m middleware.IMiddleware)

func RegisterPOST

func RegisterPOST(route string, actionFunc any, params ...string)

RegisterPOST 注册单个Api

func RegisterPUT

func RegisterPUT(route string, actionFunc any, params ...string)

RegisterPUT 注册单个Api

func RegisterRoutes

func RegisterRoutes(routes []Route)

RegisterRoutes 批量注册路由

func Run

func Run(params ...string)

func UseApiResponse

func UseApiResponse()

UseApiResponse 支持ApiResponse结构

func UseCors

func UseCors()

UseCors 使用CORS中间件

func UseStaticFiles

func UseStaticFiles()

UseStaticFiles 支持静态目录，在根目录./wwwroot中的文件，直接以静态文件提供服务

func UseWebApi

func UseWebApi()

Types

type Module

type Module struct {
}

func (Module) DependsModule

func (module Module) DependsModule() []modules.FarseerModule

func (Module) Initialize

func (module Module) Initialize()

func (Module) PostInitialize

func (module Module) PostInitialize()

func (Module) PreInitialize

func (module Module) PreInitialize()

func (Module) Shutdown

func (module Module) Shutdown()

type Route

type Route struct {
	Url    string
	Method string
	Action any
	Params []string
}

Route 路由配置