使用 Golang 编写简单的 REST API

让我们这样做👍🏻

你好😀

在这篇简短的文章中，我将解释如何使用Golang编写REST API并尝试遵循一些最佳实践。

如果需要的话，可以参考这里的源代码。

让我们这样做👍🏻

作为示例，我们将创建一个非常简单的 Post API。

项目结构

让我们跳转到我们的终端并为我们的项目创建一个新目录，然后初始化一个 go 模块。



mkdir postapi
cd postapi
go mod init postapi

注意：模块命名的最佳实践是使用<domain>/<nameOfApp>

现在我们有了这些，让我们用我们最喜欢的代码编辑器打开我们的项目，并创建一个main.go带有 main 包的文件。这将是我们应用程序的入口点。

接下来，创建一个包含文件的包应用程序app.go

在其中，我们将创建一个 App 结构体来表示我们应用的结构。这个结构体包含两个字段：DB和Router。
路由器将使用gorilla/mux路由器，因此我们先导入它：

go get -u github.com/gorilla/mux

让我们将它添加到我们的结构中

现在我们将创建一个New()函数，它将负责根据我们的结构返回实际的应用程序。

现在main.go我们可以在我们的文件中调用此函数并创建一个新的应用程序。

好的，应用程序的入口点已经结构化，让我们继续进行路由。

路由

让我们使用之前定义的App的Router来实现基本的路由。在我们的文件中，我们将创建一个InitRoutes函数，它将在创建应用程序时在New()函数内部被调用。这个函数将成为我们App的接收器。实际上，从现在开始，我们的很多方法都将成为应用程序的接收器。由于结构体App中的 Router 字段属于gorilla/mux router 类型，因此我们可以访问它的方法。
app.go

让我们快速地用一个简单的处理程序来替换索引路由中的nil。为此，handlers.go在我们的 app 包中创建一个文件。我们将在这里存储路由的处理程序。我将创建一个IndexHandler()处理程序，它将返回一个http.HandlerFunc函数，打印“Welcome to Post API”的响应。

现在让我们在路线中调用这个处理程序。

完美，为了测试一下，我们需要回到文件，main.go在我们选择的端口上为应用程序提供服务，并将其重定向到我们的应用程序 Router。此外，我还创建了一个检查函数来打印错误处理的帮助信息。

好的，现在我们可以运行我们的应用程序go run main.go并卷曲端点以查看是否得到响应。

curl http://localhost:9000

太棒了，路由似乎正在起作用！

数据库

现在是时候设置我们的数据库了，我选择使用PostgreSQL，为了避免本地设置，我将在Docker容器上运行我的数据库。

我将使用以下命令：



docker run --name postapidb --env POSTGRES_PASSWORD=postgres -p 5432:5432 -d postgres

注意：要停止，您只需运行docker stop postapidb并删除它docker rm postapidb

好的，现在我们已经有一个正在运行的数据库，让我们跳转到代码并在我们的应用程序包内创建一个新的包数据库。

让我们创建一个db.go文件，并在其中添加一个接口。我将其命名为PostDB。这个接口就像一个契约（需要实现的方法），如果我们想将数据库用作PostDB数据库，就必须遵守它。首先，PostDB应该实现一个Open()和一个Close( )方法，这两个方法可以返回错误。