通过示例学习 Go：第 2 部分 - 在 Go 中创建 HTTP REST API 服务器

心已赠人 2023-10-12 11:13 61阅读 0赞

在第一篇文章中，我们设置了我们的环境。现在，我们将创建我们的第一个应用程序：Go 中的 HTTP REST API 服务器。

初始化  
首先，我们可以在 GitHub 中创建我们的存储库（以便共享和开源）。

为此，我登录了GitHub 网站，单击存储库链接，单击“新建”绿色按钮，然后我创建了一个名为“learning-go-by-example”的新存储库。

现在，在你的本地计算机上，git clone 这个新的存储库到你想要的地方：

$ git clone https://github.com/scraly/learning-go-by-examples.git
    $ cd learning-go-by-examples

由于我们将重新使用这个 Git 存储库，我们将为go-rest-api我们的第一个应用程序创建一个文件夹并进入其中：

$ mkdir go-rest-api
    $ cd go-rest-api

现在，我们必须初始化 Go 模块（依赖管理）：

$ go mod init github.com/scraly/learning-go-by-examples/go-rest-api
    go: creating new go.mod: module github.com/scraly/learning-go-by-examples/go-rest-api

这将创建一个go.mod这样的文件：

module github.com/scraly/learning-go-by-examples/go-rest-api
    
    go 1.16

在开始我们很棒的 API 之前，作为良好实践，我们将创建一个简单的代码组织。

创建以下文件夹组织：

.
    ├── README.md
    ├── bin
    ├── doc
    ├── go.mod
    ├── internal
    ├── pkg
        └── swagger

让我们创建我们的 HTTP 服务器  
Go 是一种强大的语言，它在其生态系统中附带了大量有用的库，例如我们感兴趣的net/http 。

我们将开始在文件夹中创建一个main.go文件internal/：

package main
    
    import (
        "fmt"
        "html"
        "log"
        "net/http"
    ) 
    
    func main() {
       
        
    
        http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
       
        
            fmt.Fprintf(w, "Hello, %q", html.EscapeString(r.URL.Path))
        })
    
        log.Println("Listening on localhost:8080")
    
        log.Fatal(http.ListenAndServe(":8080", nil))
    }

这个简单的例子启动了一个 HTTP 服务器，监听端口 8080 传入的请求，服务于 / 并返回“Hello”+ 路径。

现在，是时候运行我们的应用程序来测试它了：

$ go run internal/main.go
    
    2021/07/12 22:10:47 Listening on localhost:8080

为了测试我们的 HTTP 服务器，我们可以在 localhost:8080 上卷曲或在您的浏览器中转到此端点：

$ curl localhost:8080
    
    Hello, "/"%

所以我们只需要在.go文件中编写一些 Go 代码然后运行go run myfile.go以测试它，太棒了！

是的，它很棒，但如果我们愿意，我们也可以使用我们的 HTTP 服务器生成一个可执行二进制文件：

$ go build -o bin/go-rest-api internal/main.go

生成文件 -> 任务文件  
执行我们所有的命令以运行我们的应用程序、打包、测试、生成 swagger 文档是很酷的……但是如果我们可以自动化它，您认为如何？

过去我使用Makefile来定义一组任务，但现在我使用 Taskfile，Makefile 的替代品。  
对于我们的应用程序，我创建了一个Taskfile.yml包含以下内容的文件：

version: "3"
    
    tasks:
        build:
            desc: Build the app
            cmds:
            - GOFLAGS=-mod=mod go build -o bin/go-rest-api internal/main.go 
    
        run: 
            desc: Run the app
            cmds:
            - GOFLAGS=-mod=mod go run internal/main.go
    
        swagger.gen:
            desc: Generate Go code
            cmds:
            - GOFLAGS=-mod=mod go generate github.com/scraly/learning-go-by-examples/go-rest-api/internal github.com/scraly/learning-go-by-examples/go-rest-api/pkg/swagger
    
        swagger.validate:
            desc: Validate swagger
            cmds:
            - swagger validate pkg/swagger/swagger.yml
    
        swagger.doc:
            desc: Doc for swagger
            cmds:
            - docker run -i yousan/swagger-yaml-to-html < pkg/swagger/swagger.yml > doc/index.html

如果需要，您可以在 GitHub 存储库中下载其最新版本。

在你的本地机器上安装task，为了做到这一点，你可以按照安装说明进行操作，或者如果你有一个带有homebrew的 MacOS ，你可以使用brew install命令：

$ brew install go-task/tap/go-task

现在您可以显示可用任务列表：

$ task --list
    task: Available tasks for this project:
    * build:        Build the app
    * run:          Run the app
    * swagger.doc:      Doc for swagger
    * swagger.gen:      generate Go code
    * swagger.validate:     Validate swagger

太棒了，我们学到了另一个好习惯！

是时候创建我们的 REST API  
太棒了，我们编写了一个 HTTP 服务器，但是 Aurélie 你谈到了 REST API，不是吗？

没错，我们现在将加强我们的 HTTP 服务器并使用Swagger，它处理我们的 HTTP 端点的定义。

什么是招摇？  
Swagger 允许您提供符合 OpenAPI 规范的 API 标准化文档。

通过输入 swagger 规范文件，借助 Swagger 应用程序，您可以生成代码，并在最后为用户提供 HTML 格式的 API 文档。

如果您想构建一个公共 API，请不要犹豫使用 Swagger。

招摇安装  
我们将安装go-swagger工具，不要犹豫，跟随安装页面。

如果您有 Mac：

$ brew tap go