组件分享之后端组件——轻松构建RESTful JSON API的
2022-05-08 本文已影响0人
cn華少
组件分享之后端组件——轻松构建RESTful JSON API的组件go-json-rest
背景
近期正在探索前端、后端、系统端各类常用组件与工具,对其一些常见的组件进行再次整理一下,形成标准化组件专题,后续该专题将包含各类语言中的一些常用组件。欢迎大家进行持续关注。
组件基本信息
- 组件:go-json-rest
- 开源协议:MIT license
内容
本节我们分享一个轻松构建RESTful JSON API的组件go-json-rest,它是一个基于net/http的封装组件,有助于轻松构建 RESTful JSON API。它使用基于 Trie 的实现提供快速且可扩展的请求路由,处理 JSON 请求和响应的助手,以及用于 CORS、Auth、Gzip、Status 等功能的中间件......
其特点如下:
- 很多例子。
- 快速且可扩展的 URL 路由。它使用 Trie 数据结构实现了经典的路由描述语法。
- 基于位于一堆中间件之上的路由器(应用程序)的架构。
- 中间件实现了 Logging、Gzip、CORS、Auth、Status 等功能。
- 实现为net/http处理程序。此标准接口允许与其他处理程序组合。
- 测试包,以帮助为您的 API 编写测试。
- 监控受 Memcached 启发的统计数据。
其核心中间件如下:
组件名称 | 描述 |
---|---|
AccessLogApache | 受 Apache mod_log_config 启发的访问日志 |
AccessLogJson | 访问日志,记录为 JSON |
AuthBasic | 基本 HTTP 身份验证 |
ContentTypeChecker | 验证请求内容类型 |
Cors | CORS 服务器端实现 |
Gzip | 压缩响应 |
If | 在运行时有条件地执行中间件 |
JsonIndent | 易于阅读的 JSON |
Jsonp | 响应为 JSONP |
PoweredBy | 管理 X-Powered-By 响应标头 |
Recorder | 记录Env中的状态码和内容长度 |
Status | Memecached 启发了有关请求的统计信息 |
Timer | 跟踪 Env 中经过的时间 |
使用这个组件包,只需要进行如下操作即可
1、安装包
go get github.com/ant0ine/go-json-rest/rest
2、案例
package main
import (
"github.com/ant0ine/go-json-rest/rest"
"log"
"net/http"
)
func main() {
api := rest.NewApi()
api.Use(rest.DefaultDevStack...)
api.SetApp(rest.AppSimple(func(w rest.ResponseWriter, r *rest.Request) {
w.WriteJson(map[string]string{"Body": "Hello World!"})
}))
log.Fatal(http.ListenAndServe(":8080", api.MakeHandler()))
}
更多使用方式,请参考其官方提供的README
本文声明:
88x31.png知识共享许可协议
本作品由 cn華少 采用 知识共享署名-非商业性使用 4.0 国际许可协议 进行许可。