如何使用 GopherLight 像专业人士一样在 Go 中编写 API

文档

GopherLight

大家好，首先我要感谢您选择使用我们的项目。尽管他很小，但我们却以极大的热情做到了！要开始使用它，您首先必须安装 go，我们假设您已经安装了它。然后安装框架的主要模块，分别是req和router

go get github.com/BrunoCiccarino/GopherLight/router
go get github.com/BrunoCiccarino/GopherLight/req

已经下载了？唷！现在我们可以制作我们的第一个hello world。

package main

import (
    "fmt"
    "github.com/BrunoCiccarino/GopherLight/router"
    "github.com/BrunoCiccarino/GopherLight/req"
)


func main() {
    app := router.NewApp()

    // Define a route that responds to a GET request at "/hello".
    app.Get("/hello", func(r *req.Request, w *req.Response) {
        w.Send("Hello, World!")
    })

    fmt.Println("Server listening on port 3333")
    app.Listen(":3333")
}

很简单，对吧？我们还可以利用 GopherLight 做更多事情。继续阅读 HTTP 方法以及我们的请求和响应工具的完整细分。

支持的 HTTP 方法
以下是您可以与 router.App 一起使用的 HTTP 方法的列表。其中每一个都允许您设置路由来处理不同类型的请求。让我们开始吧！

得到

• 用法：app.Get(路径，处理程序)

检索数据而不修改任何内容。
示例：获取项目列表或读取用户详细信息。

邮政

• 用法：app.Post(路径，处理程序)

发送数据以创建新资源。
示例：提交表单或向列表添加新项目。

放

用法：app.Put(路径, 处理程序)

更新或替换资源。这是一个“覆盖”操作。
示例：更新完整的用户个人资料。

删除

用法：app.Delete(path, handler)

删除资源。
示例：删除用户或删除帖子。

修补

用法：app.Patch(path, handler)

部分更新资源而不替换所有内容。
示例：仅更新用户个人资料上的电子邮件。

选项

用法：app.Options(path, handler)

返回 URL 允许的 HTTP 方法，主要用于 CORS 预检请求。

头

用法：app.Head(路径, 处理程序)

与 GET 类似，但没有响应正文。用它来检查资源是否存在。

连接和追踪

用法：app.Connect(path, handler), app.Trace(path, handler)

高级方法：CONNECT建立隧道（用于SSL），TRACE用于调试，回显请求。

使用 req.Request 和 req.Response

现在您已经了解了路由，让我们来谈谈请求和响应对象，它们是处理传入请求和发送响应的首选助手。

要求

每个请求处理程序都会获取一个请求对象，其中加载了传入请求的信息。您可以使用它执行以下操作：

• 查询参数：通过 .QueryParam("key") 获取查询参数。
• 标头：使用 .Header("key") 访问标头。
• Body as String：使用 .BodyAsString() 获取请求正文。

例子：

go get github.com/BrunoCiccarino/GopherLight/router
go get github.com/BrunoCiccarino/GopherLight/req

回复

Response 对象可帮助您将回复发送回客户端。您可以执行以下操作：

• 发送文本：.Send(data string) 写回纯文本。
• 设置状态：.Status(code) 设置 HTTP 状态。
• 发送 JSON：.JSON(data) 将 Go 对象序列化为 JSON 并发送。
• 处理错误：.JSONError(message) 发送 JSON 格式的错误响应。

例子：

package main

import (
    "fmt"
    "github.com/BrunoCiccarino/GopherLight/router"
    "github.com/BrunoCiccarino/GopherLight/req"
)


func main() {
    app := router.NewApp()

    // Define a route that responds to a GET request at "/hello".
    app.Get("/hello", func(r *req.Request, w *req.Response) {
        w.Send("Hello, World!")
    })

    fmt.Println("Server listening on port 3333")
    app.Listen(":3333")
}

中间件

我们已经准备好了一批中间件，供您向 Go Web 应用程序添加一些重要的功能。这些中间件中的每一个都有自己的魔力——安全性、日志记录、超时等等！让我们一一分解。 ？

身份验证中间件 (JWT)

我们的 AuthMiddleware 使用 JSON Web 令牌 (JWT) 帮助保护您的路由。它很灵活，可以让您自定义密钥、错误处理和令牌提取方法。

设置
首先，使用 JWTConfig 配置您的 JWT 设置：

• SecretKey：用于签署 JWT 的密钥。
• SigningMethod：JWT 签名算法。
• ErrorHandler：用于处理身份验证错误的自定义错误处理程序（可选）。
• TokenExtractor：从请求标头中提取令牌（可选）。

例子

app.Get("/greet", func(r *req.Request, w *req.Response) {
    name := r.QueryParam("name")
    if name == "" {
        name = "stranger"
    }
    w.Send("Hello, " + name + "!")
})

CORS中间件

需要允许跨域请求？没问题！我们的 COSM 中间件配置跨源资源共享 (CORS) 设置，使您的 API 可从其他域访问。

配置选项

• AllowOrigin：设置为“*”以允许任何来源或指定域（例如“http://example.com”）。
• AllowMethods：允许哪些 HTTP 方法？常见的选择包括“GET”、“POST”等
• AllowHeaders：指定客户端可以使用哪些标头。
• AllowCredentials：如果您希望包含 cookie 或 HTTP 身份验证，请设置为 true。
• ExposeHeaders：让客户端从响应中读取特定标头。
• MaxAge：预检请求的缓存时间（以秒为单位）。

例子

app.Get("/user", func(r *req.Request, w *req.Response) {
    user := map[string]string{"name": "Gopher", "language": "Go"}
    w.JSON(user)
})

CSRF中间件

我们的 CSRFMiddleware 通过验证随每个请求发送的 CSRF 令牌来防止跨站点请求伪造。使用GenerateCSRFToken() 创建安全令牌，然后使用您自己的isValidToken 函数对其进行验证。

例子

import (
    "github.com/BrunoCiccarino/GopherLight/middleware"
)

config := middleware.JWTConfig{
    SecretKey: []byte("your_secret_key"),
}
app.Use(middleware.NewAuthMiddleware(config))

并且不要忘记使用以下方式生成令牌：

go get github.com/BrunoCiccarino/GopherLight/router
go get github.com/BrunoCiccarino/GopherLight/req

日志中间件

想要跟踪服务器上发生的情况吗？ LoggingMiddleware 记录每个请求，包括方法、路径和所用时间。这是了解应用性能和任何异常活动的好方法。

例子

package main

import (
    "fmt"
    "github.com/BrunoCiccarino/GopherLight/router"
    "github.com/BrunoCiccarino/GopherLight/req"
)


func main() {
    app := router.NewApp()

    // Define a route that responds to a GET request at "/hello".
    app.Get("/hello", func(r *req.Request, w *req.Response) {
        w.Send("Hello, World!")
    })

    fmt.Println("Server listening on port 3333")
    app.Listen(":3333")
}

每个请求都会像这样记录：

• 开始：记录请求开始时间。
• 已完成：请求完成时记录，包括持续时间。

超时中间件

通过使用 TimeoutMiddleware 设置请求处理的时间限制来避免无休止的等待。如果请求未及时完成，该中间件将取消请求，并向客户端发送 504 网关超时状态。

例子

app.Get("/greet", func(r *req.Request, w *req.Response) {
    name := r.QueryParam("name")
    if name == "" {
        name = "stranger"
    }
    w.Send("Hello, " + name + "!")
})

插件接口

插件界面超级简单但功能超级强大。它为您提供了一个方法：注册。这使您可以连接到应用程序的路由系统来添加您需要的任何路由 - 无论是新的 API 端点、Webhook 还是您可以想象的任何其他内容。

注册方法
这是插件界面的神奇部分：

app.Get("/user", func(r *req.Request, w *req.Response) {
    user := map[string]string{"name": "Gopher", "language": "Go"}
    w.JSON(user)
})

Register 方法接受一个路由函数，允许您通过指定以下方式在插件中定义新路由：

• 方法：HTTP 方法（例如“GET”、“POST”等）
• path：路由路径（例如“/my-plugin-route”）
• handler：命中路由时执行的函数。该函数接收：
  • req：可以访问查询参数、标头和正文的请求对象。
  • res：将数据发送回客户端的响应对象。

示例插件

假设您想要创建一个插件，在 /hello-plugin 处添加一个简单的端点来欢迎用户。该插件如下所示：

import (
    "github.com/BrunoCiccarino/GopherLight/middleware"
)

config := middleware.JWTConfig{
    SecretKey: []byte("your_secret_key"),
}
app.Use(middleware.NewAuthMiddleware(config))

将插件添加到您的应用程序

要加载插件，只需创建一个实例并在主应用程序设置中调用 Register：

corsOptions := middleware.CORSOptions{
    AllowOrigin: "*",
    AllowMethods: []string{"GET", "POST"},
}
app.Use(middleware.CORSMiddleware(corsOptions))

定制您的插件

每个插件都可以根据需要添加任意数量的路由。只需在 Register 函数中多次调用路由即可定义其他端点。使用不同的 HTTP 方法、路径和处理程序来根据需要塑造插件的功能。

以上是如何使用 GopherLight 像专业人士一样在 Go 中编写 API的详细内容。更多信息请关注PHP中文网其他相关文章！