本教程介绍了使用Go和GinWeb框架(Gin)编写RESTfulWeb服务API的基础知识。
Gin简化了编写web应用程序中许多代码任务。在本教程中,我们会使用Gin来路由请求、获取请求细节、整理成JSON返回响应。
在本教程中,我们将构建一个有两个endpoint的RESTfulAPI服务。我们的示例项目是一个关于复古爵士乐唱片的数据仓库。
本教程包含以下部分:
设计APIendpoints
为代码创建目录
创建数据
写一个返回所有项的控制器
写一个创建新项的控制器
写一个返回具体某一项的控制器
前提准备
安装Go1.16或者更新的版本
编辑代码的工具。任何文本编辑器都可以
终端。在Linux和Mac上使用任何终端都可以,在Windows上使用PowerShell或者cmd
curl工具。
设计APIendpoints
我们将将构建一个API,用于访问销售黑胶老式唱片的商店。因此,我们需要提供endpoint,客户端可以通过这些endpoint为用户获取和添加专辑。
在开发API时,通常从设计endpoint开始。易于理解的endpoint能容易被用户使用。
以下是本教程创建的endpoint:
/albums
GET-获取专辑列表,返回JSON格式数据
POST-从请求的JSON数据中增加一个新的专辑
/albums/:id
GET-通过ID获取一个专辑,并且用JSON格式返回专辑数据
下面,为我们的代码创建目录
为代码创建目录
首先,为我们的代码创建一个项目
打开一个命令行并且切换至工作目录
在Linux或者Mac:
$cd
在Windows:
C:\cd%HOMEPATH%
使用命令创建我们的代码目录,名为web-service-gin
$mkdirweb-service-gin$cdweb-service-gin
创建一个模块来管理依赖
运行gomodinit命令,给定我们代码所在的模块路径
$gomodinitexample.