开源项目 `gorest` 使用教程

开源项目 gorest 使用教程

gorestGo RESTful API starter kit with Gin, JWT, GORM (MySQL, PostgreSQL, SQLite), Redis, Mongo, 2FA, email verification, password recovery项目地址:https://gitcode.com/gh_mirrors/go/gorest

项目介绍

gorest 是一个用于快速测试和原型设计的在线假 GraphQL 和 REST API 服务。它支持认证和自定义速率限制，非常适合用于 Web 和 Android 应用程序的快速开发和测试。

项目快速启动

环境准备

确保你已经安装了以下工具：

• Go (版本 1.16 或更高)
• Git

克隆项目

git clone https://github.com/pilinux/gorest.git
cd gorest

安装依赖

go mod download

运行项目

go run main.go

项目默认运行在 http://localhost:8080。

应用案例和最佳实践

案例一：使用 REST API 进行用户管理

假设你需要一个简单的用户管理系统，可以使用 gorest 提供的 REST API 进行快速开发。

1. 创建用户

curl -X POST http://localhost:8080/users -d '{"name": "Alice", "email": "alice@example.com"}'

2. 获取用户列表

curl http://localhost:8080/users

3. 更新用户信息

curl -X PUT http://localhost:8080/users/1 -d '{"name": "Alice Smith", "email": "alice.smith@example.com"}'

4. 删除用户

curl -X DELETE http://localhost:8080/users/1

案例二：使用 GraphQL API 进行数据查询

假设你需要进行复杂的数据查询，可以使用 gorest 提供的 GraphQL API。

1. 查询用户信息

query {
  users {
    id
    name
    email
  }
}

2. 创建用户

mutation {
  createUser(input: {name: "Bob", email: "bob@example.com"}) {
    id
    name
    email
  }
}

典型生态项目

1. gqlgen

gqlgen 是一个用于构建 GraphQL 服务器的 Go 库，与 gorest 结合使用可以快速构建强大的 GraphQL API。

2. gin

gin 是一个高性能的 Go Web 框架，与 gorest 结合使用可以构建高效的 REST API。

3. jwt-go

jwt-go 是一个用于处理 JSON Web Tokens (JWT) 的 Go 库，与 gorest 结合使用可以实现安全的认证机制。

通过以上教程，你应该能够快速上手并使用 gorest 进行开发和测试。希望这些内容对你有所帮助！

gorestGo RESTful API starter kit with Gin, JWT, GORM (MySQL, PostgreSQL, SQLite), Redis, Mongo, 2FA, email verification, password recovery项目地址:https://gitcode.com/gh_mirrors/go/gorest