」工欲善其事,必先利其器。「—孔子《論語.錄靈公》
首頁 > 程式設計 > 如何使用 GopherLight 像專業人士一樣在 Go 中編寫 API

如何使用 GopherLight 像專業人士一樣在 Go 中編寫 API

發佈於2024-11-18
瀏覽:641

How to Write APIs Like a Pro in Go with GopherLight

文档

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(path, handler)

更新或替换资源。这是一个“覆盖”操作。
示例:更新完整的用户配置文件。

删除

用法:app.Delete(path, handler)

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

修补

用法:app.Patch(path, handler)

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

选项

用法:app.Options(path, handler)

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

用法:app.Head(path, handler)

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

连接和追踪

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

高级方法:CONNECT建立隧道(用于SSL),TRACE用于调试,回显请求。

使用 req.Request 和 req.Response

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

要求

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

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

例子:

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

回复

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

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

例子:

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

中间件

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

身份验证中间件 (JWT)

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

设置
首先,使用 JWTConfig 配置 JWT 设置:

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

例子

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

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

CORS中间件

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

配置选项

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

例子

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

CSRF中间件

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

例子

app.Use(middleware.CSRFMiddleware(func(token string) bool {
    return token == "your_valid_token"
}))

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

csrfToken := middleware.GenerateCSRFToken()

日志中间件

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

例子

app.Use(middleware.LoggingMiddleware)

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

  • 开始:记录请求开始时间。
  • Completed:请求完成时记录,包括持续时间。

超时中间件

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

例子

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

timeout := 2 * time.Second
app.Use(middleware.TimeoutMiddleware(timeout))

插件接口

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

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

type Plugin interface {
    Register(route func(method, path string, handler func(req *req.Request, res *req.Response)))
}

Register 方法接受一个路由函数,允许您通过指定在插件中定义新路由:

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

示例插件

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

package main

import (
    "github.com/BrunoCiccarino/GopherLight/plugins"
    "github.com/BrunoCiccarino/GopherLight/req"
)

type HelloPlugin struct{}

// Register adds a new route for the HelloPlugin.
func (p *HelloPlugin) Register(route func(method, path string, handler func(req *req.Request, res *req.Response))) {
    route("GET", "/hello-plugin", func(req *req.Request, res *req.Response) {
        res.Send("Hello from the HelloPlugin!")
    })
}

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

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

package main

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

func main() {
    app := router.NewApp()
    helloPlugin := &HelloPlugin{}
    helloPlugin.Register(app.Route)

    app.Listen(":3333")
}

定制您的插件

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

版本聲明 本文轉載於:https://dev.to/gopherlight/how-to-write-apis-like-a-pro-in-go-with-gopherlight-3b97?1如有侵犯,請洽[email protected]刪除
最新教學 更多>
  • 哪種方法更有效地用於點 - 填點檢測:射線跟踪或matplotlib \的路徑contains_points?
    哪種方法更有效地用於點 - 填點檢測:射線跟踪或matplotlib \的路徑contains_points?
    在Python 射線tracing方法 matplotlib路徑對象表示多邊形。它檢查給定點是否位於定義路徑內。 This function is often faster than the ray tracing approach, as seen in the code snippet pr...
    程式設計 發佈於2025-02-19
  • 如何在JavaScript對像中動態設置鍵?
    如何在JavaScript對像中動態設置鍵?
    如何為JavaScript對像變量創建動態鍵,嘗試為JavaScript對象創建動態鍵,使用此Syntax jsObj['key' i] = 'example' 1;將不起作用。正確的方法採用方括號:他們維持一個長度屬性,該屬性反映了數字屬性(索引)和一個數字屬性的數量。標準對像沒有模仿這...
    程式設計 發佈於2025-02-19
  • 如何可靠地檢查MySQL表中的列存在?
    如何可靠地檢查MySQL表中的列存在?
    在mySQL中確定列中的列存在,驗證表中的列存在與與之相比有點困惑其他數據庫系統。常用的方法:如果存在(從信息_schema.columns select * * where table_name ='prefix_topic'和column_name =&...
    程式設計 發佈於2025-02-19
  • 如何為PostgreSQL中的每個唯一標識符有效地檢索最後一行?
    如何為PostgreSQL中的每個唯一標識符有效地檢索最後一行?
    [2最後一行與數據集中的每個不同標識符關聯。考慮以下數據: 1 2014-02-01 kjkj 1 2014-03-11 ajskj 3 2014-02-01 sfdg 3 2014-06-12 fdsa 為了檢索數據集中每個唯一ID的最後一行信息,您可以在操作員上使用Postgres的有效效...
    程式設計 發佈於2025-02-19
  • 如何使用char_length()在mySQL中按字符串長度對數據進行排序?
    如何使用char_length()在mySQL中按字符串長度對數據進行排序?
    [2使用內置的char_length()函數。 :返回字符串中的字符數,考慮多BYTE字符encoding(例如UTF-8)。 ] :返回字符串佔用的字節數,該字符的數量可能無法準確反映字符計數多字節編碼。 [&& && && && && && &&華從指定的表格中的所有行,並根據指定列的字符長度...
    程式設計 發佈於2025-02-19
  • 如何檢查對像是否具有Python中的特定屬性?
    如何檢查對像是否具有Python中的特定屬性?
    方法來確定對象屬性存在尋求一種方法來驗證對像中特定屬性的存在。考慮以下示例,其中嘗試訪問不確定屬性會引起錯誤: >>> a = someClass() >>> A.property Trackback(最近的最新電話): 文件“ ”,第1行, AttributeError:SomeClass實...
    程式設計 發佈於2025-02-19
  • 在映射到MySQL枚舉列時,如何確保冬眠保留值?
    在映射到MySQL枚舉列時,如何確保冬眠保留值?
    在hibernate中保存枚舉值:故障排除錯誤的列type ,他們各自的映射至關重要。在Java中使用枚舉類型時,至關重要的是,建立冬眠的方式如何映射到基礎數據庫。 在您的情況下,您已將MySQL列定義為枚舉,並在Java中創建了相應的枚舉代碼。但是,您遇到以下錯誤:“ MyApp中的錯誤列類型...
    程式設計 發佈於2025-02-19
  • 如何使用替換指令在GO MOD中解析模塊路徑差異?
    如何使用替換指令在GO MOD中解析模塊路徑差異?
    克服go mod中的模塊路徑差異 github.com/coreos/etcd/integration imports :解析GO.mod:模塊將其路徑聲明為: go.etcd.io/bbolt [&&&&&&&&&&&&&&&&&&&&&&&&&&&& github.com/coreos/b...
    程式設計 發佈於2025-02-19
  • 如何使用PHP從XML文件中有效地檢索屬性值?
    如何使用PHP從XML文件中有效地檢索屬性值?
    從php 您的目標可能是檢索“ varnum”屬性值,其中提取數據的傳統方法可能會使您留下PHP陷入困境。 使用simplexmlelement :: attributes()函數提供了簡單的解決方案。此函數可訪問對XML元素作為關聯數組的屬性: - > attributes()為$ att...
    程式設計 發佈於2025-02-19
  • Java是否允許多種返回類型:仔細研究通用方法?
    Java是否允許多種返回類型:仔細研究通用方法?
    在java中的多個返回類型:一個誤解介紹,其中foo是自定義類。該方法聲明似乎擁有兩種返回類型:列表和E。但是,情況確實如此嗎? 通用方法:拆開神秘 [方法僅具有單一的返回類型。相反,它採用機制,如鑽石符號“ ”。 分解方法簽名: :本節定義了一個通用類型參數,E。它表示該方法接受擴展FOO類的...
    程式設計 發佈於2025-02-19
  • 大批
    大批
    [2 數組是對象,因此它們在JS中也具有方法。 切片(開始):在新數組中提取部分數組,而無需突變原始數組。 令ARR = ['a','b','c','d','e']; // USECASE:提取直到索引作...
    程式設計 發佈於2025-02-19
  • 在沒有密碼提示的情況下,如何在Ubuntu上安裝MySQL?
    在沒有密碼提示的情況下,如何在Ubuntu上安裝MySQL?
    在ubuntu 使用debconf-set-selections 在安裝過程中避免密碼提示mysql root用戶。這需要以下步驟: sudo debconf-set-selections
    程式設計 發佈於2025-02-19
  • 如何以不同的頻率控制Android設備振動?
    如何以不同的頻率控制Android設備振動?
    控制使用頻率變化的Android設備振動是否想為您的Android應用程序添加觸覺元素?了解如何觸發設備的振動器至關重要。您可以做到這一點:生成基本振動以生成簡單的振動,使用振動器對象:這將導致設備在指定的持續時間內振動。 許可要求通過上述技術,您可以創建在您的Android應用程序中自定義振動,以...
    程式設計 發佈於2025-02-19
  • 如何克服PHP的功能重新定義限制?
    如何克服PHP的功能重新定義限制?
    克服PHP的函數重新定義限制在PHP中,多次定義一個相同名稱的函數是一個no-no。嘗試這樣做,如提供的代碼段所示,將導致可怕的“不能重新列出”錯誤。 //錯誤:“ cance redeclare foo()” 但是,PHP工具腰帶中有一個隱藏的寶石:runkit擴展。它使您能夠靈活地重新定...
    程式設計 發佈於2025-02-19

免責聲明: 提供的所有資源部分來自互聯網,如果有侵犯您的版權或其他權益,請說明詳細緣由並提供版權或權益證明然後發到郵箱:[email protected] 我們會在第一時間內為您處理。

Copyright© 2022 湘ICP备2022001581号-3