restgo/rest

Rest

!https://github.com/rest-go/rest/actions/workflows/ci.yml/badge.svg https://codecov.io/gh/rest-go/rest/branch/main/graph/badge.svg?token=T38FWXMVY1](https://codecov.io/gh/rest-go/rest)

Rest可从任意SQL数据库生成完整的RESTful API，目前支持PostgreSQL、MySQL和SQLite。访问 [***] 获取完整文档、示例和指南。

核心功能

• CRUD操作
• 分页查询
• 比较运算符（等于、小于、大于等）
• 字段选择
• 排序
• 计数统计
• JSON格式支持
• 认证与授权

使用场景

1. 快速构建数据库的RESTful接口，减少重复开发
2. 嵌入现有Go HTTP服务，扩展数据接口能力
3. 原型开发阶段快速验证数据交互逻辑

配置说明与部署示例

Docker部署

连接现有数据库

bash
# 连接PostgreSQL
docker run -p 3000:3000 restgo/rest -db.url "postgres://user:passwd@localhost:5432/db"

# 连接SQLite文件（需挂载卷）
docker run -p 3000:3000 -v $(pwd):/data restgo/rest -db.url "sqlite:///data/my.db"

API使用示例

假设数据库中有todos表（含id、title、done字段）：

bash
# 创建待办项
curl -XPOST "localhost:3000/todos" -d '{"title": "搭建API服务器", "done": false}'

# 读取待办项
curl -XGET "localhost:3000/todos/1"

# 更新待办项
curl -XPUT "localhost:3000/todos/1" -d '{"title": "搭建API服务器", "done": true}'

# 删除待办项
curl -XDELETE "localhost:3000/todos/1"

作为Go库使用

将Rest嵌入现有Go服务：

1. 安装依赖

bash
go get github.com/rest-go/rest

2. 示例代码

go
package main

import (
	"log"
	"net/http"

	"github.com/rest-go/rest/pkg/server"
)

func main() {
	h := server.New(&server.DBConfig{URL: "sqlite://my.db"}, server.Prefix("/admin"))
	http.Handle("/admin/", h)
	log.Fatal(http.ListenAndServe(":3001", nil))
}

未来规划

• 资源嵌入（一对一、一对多）
• 逻辑运算符（与、或）
• Open API文档生成