Go语言-初学者日记(七):用 Go 写一个 RESTful API 服务!

news2025/4/10 22:36:02

👷 实践是最好的学习方式!这一篇我们将用 Go + Gin 框架从零开始开发一个用户管理 API 服务。你将学到:

  • 如何初始化项目并引入依赖
  • 如何组织目录结构
  • 如何用 Gin 实现 RESTful 接口
  • 如何通过 curl 测试 API
  • 进阶功能拓展建议

🧰 一、项目初始化与依赖安装

第一步,先创建项目目录并初始化 Go Modules:

mkdir go-user-api && cd go-user-api
go mod init github.com/yourname/go-user-api

然后安装我们将使用的 Web 框架 —— Gin:

go get -u github.com/gin-gonic/gin

✅ 你现在已经具备开发 Go Web 服务的基本环境。


📁 二、推荐的项目目录结构

保持简单,便于理解,也方便未来扩展:

go-user-api/
├── main.go               # 应用入口
├── go.mod                # 模块定义
├── go.sum                # 依赖锁定文件
├── handlers/             # 路由处理逻辑
│   └── user.go
└── models/               # 数据模型结构体(可选)

📌 提醒:随着项目变复杂,可拆分出 service/, middleware/, config/, router/, utils/ 等目录。


🧪 三、实现用户 API 接口

目标是实现两个基础接口:

  • GET /users:返回所有用户数据
  • POST /users:添加一个新用户
📄 main.go
package main

import (
    "github.com/gin-gonic/gin"
    "go-user-api/handlers"
)

func main() {
    r := gin.Default()

    // 注册路由
    r.GET("/users", handlers.GetUsers)
    r.POST("/users", handlers.CreateUser)

    // 启动服务
    r.Run(":8080")
}
📄 handlers/user.go
package handlers

import (
    "net/http"
    "github.com/gin-gonic/gin"
)

// 模拟用户结构体和数据
type User struct {
    ID   int    `json:"id"`
    Name string `json:"name"`
}

var users = []User{
    {ID: 1, Name: "Alice"},
    {ID: 2, Name: "Bob"},
}

// GET /users
func GetUsers(c *gin.Context) {
    c.JSON(http.StatusOK, users)
}

// POST /users
func CreateUser(c *gin.Context) {
    var newUser User
    if err := c.ShouldBindJSON(&newUser); err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
        return
    }
    newUser.ID = len(users) + 1
    users = append(users, newUser)
    c.JSON(http.StatusCreated, newUser)
}

🧪 四、启动服务并测试接口

启动服务:
go run main.go

服务默认监听 http://localhost:8080

使用 curl 测试接口

📥 获取用户列表:

curl http://localhost:8080/users

📤 添加新用户:

curl -X POST http://localhost:8080/users   -H "Content-Type: application/json"   -d '{"name":"Charlie"}'

返回示例:

{
  "id": 3,
  "name": "Charlie"
}

🔧 五、接口设计补充说明

推荐的 RESTful 风格规范:
请求方法路径含义
GET/users查询所有用户
GET/users/:id查询单个用户
POST/users创建新用户
PUT/users/:id更新用户信息
DELETE/users/:id删除用户

这些是 RESTful 接口的基本设计规范,在大型项目中非常常见。


📦 六、进阶拓展建议

✅ 想继续提升?你可以尝试:

  • 🗄 接入 GORM 实现真实数据库(SQLite / MySQL)
  • ✏️ 添加表单校验:使用 Gin 的 binding + validator
  • 🔐 增加登录、注册与 JWT 身份认证
  • 🧪 编写单元测试(使用 httptest.NewRecorder()
  • 🛡️ 使用中间件做访问日志、限流、错误恢复等处理
  • 📂 添加日志框架如 zap,记录结构化日志
  • 📚 提取配置文件(使用 viper 管理 YAML/JSON)

🧠 七、小结与回顾

本篇我们完成了一个完整的 Go + Gin 实战项目的搭建和基本功能实现。你已经学到了:

  • 如何初始化 Go 项目并安装依赖
  • 如何用 Gin 实现基础的 API 路由与处理
  • 如何通过 curl 工具测试接口
  • 如何组织项目目录结构以支持未来拓展

📌 实战才是学习的核心,加油!后续我们会继续介绍部署与上线技巧 🚀


🪧 下一篇预告

🚀 Go语言-初学者日记(八):部署与构建——Go 项目上线指南
包括 go build 编译、Docker 打包、环境变量配置、部署上线等内容,敬请期待!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2328614.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

Java 搭建 MC 1.18.2 Forge 开发环境

推荐使用 IDEA 插件 Minecraft Development 进行创建项目 创建完成后即可进行 MOD 开发。 但是关于 1.18.2 的开发教程太少,因此自己研究了一套写法,写法并非是最优的但是是探索开发MOD中的一次笔记和记录 GITHUB: https://github.com/zimoyin/zhenfa…

计算机网络知识点汇总与复习——(三)数据链路层

Preface 计算机网络是考研408基础综合中的一门课程,它的重要性不言而喻。然而,计算机网络的知识体系庞大且复杂,各类概念、协议和技术相互关联,让人在学习时容易迷失方向。在进行复习时,面对庞杂的的知识点&#xff0c…

主机和虚拟机间的网络通信

参考:Vmware虚拟机三种网络模式详解 - 林加欣 - 博客园 (cnblogs.com) 虚拟机配置 一般额外配置有线和无线网络 桥接模式 虚拟机和主机之间是同一个网络,用一根线连接了虚拟机和物理机的网卡,可以选择桥接的位置,默认情况下是自动桥接&…

嵌入式Linux开发环境搭建,三种方式:虚拟机、物理机、WSL

目录 总结写前面一、Linux虚拟机1 安装VMware、ubuntu18.042 换源3 改中文4 中文输入法5 永不息屏6 设置 root 密码7 安装 terminator8 安装 htop(升级版top)9 安装 Vim10 静态IP-虚拟机ubuntu11 安装 ssh12 安装 MobaXterm (SSH)…

说清楚单元测试

在团队中推行单元测试的时候,总是会被成员问一些问题: 这种测试无法测试数据库的SQL(或者是ORM)是否执行正确?这种测试好像没什么作用?关联的对象要怎么处理呢?…借由本篇,来全面看一看单元测试。 单元测试是软件开发中一种重要的测试方法,其核心目的是验证代码的最小…

电商---part02 项目环境准备

1.虚拟机环境 可以通过VMWare来安装,但是通过VMWare安装大家经常会碰到网络ip连接问题,为了减少额外的环境因素影响,Docker内容会通过VirtualBox结合Vagrant来安装虚拟机。 VirtualBox官网:https://www.virtualbox.org/ Vagran…

LabVIEW提升程序响应速度

LabVIEW 程序在不同计算机上的响应速度可能存在较大差异,这通常由两方面因素决定:计算机硬件性能和程序本身的优化程度。本文将分别从硬件配置对程序运行的影响以及代码优化方法进行详细分析,帮助提升 LabVIEW 程序的执行效率。 一、计算机硬…

工业领域网络安全技术发展路径洞察报告发布 | FreeBuf咨询

工业网络安全已成为国家安全、经济稳定和社会运行的重要基石。随着工业互联网、智能制造和关键基础设施的数字化升级,工业系统的复杂性和互联性显著提升,针对工业领域的网络攻击朝着目标多样化、勒索攻击产业化、攻击技术持续升级的方向发展,…

WPF 登录页面

效果 项目结构 LoginWindow.xaml <Window x:Class"PrismWpfApp.Views.LoginWindow"xmlns"http://schemas.microsoft.com/winfx/2006/xaml/presentation"xmlns:x"http://schemas.microsoft.com/winfx/2006/xaml"xmlns:d"http://schemas.…

【数学建模】动态规划算法(Dynamic Programming,简称DP)详解与应用

动态规划算法详解与应用 文章目录 动态规划算法详解与应用引言动态规划的基本概念动态规划的设计步骤经典动态规划问题1. 斐波那契数列2. 背包问题3. 最长公共子序列(LCS) 动态规划的优化技巧动态规划的应用领域总结 引言 动态规划(Dynamic Programming&#xff0c;简称DP)是一…

leetcode-代码随想录-链表-移除链表元素

题目 链接&#xff1a;203. 移除链表元素 - 力扣&#xff08;LeetCode&#xff09; 给你一个链表的头节点 head 和一个整数 val &#xff0c;请你删除链表中所有满足 Node.val val 的节点&#xff0c;并返回 新的头节点 。 输入&#xff1a;head [1,2,6,3,4,5,6], val 6 …

论文阅读Diffusion Autoencoders: Toward a Meaningful and Decodable Representation

原文框架图&#xff1a; 官方代码&#xff1a; https://github.com/phizaz/diffae/blob/master/interpolate.ipynb 主要想记录一下模型的推理过程 &#xff1a; %load_ext autoreload %autoreload 2 from templates import * device cuda:1 conf ffhq256_autoenc() # pri…

Python集合(五)

集合一&#xff1a; 跟字典一样&#xff0c;最大的特性就是唯一性&#xff0c;集合中的所有的元素都是独一无二的&#xff0c;并且还是无序的 创建集合 第一种&#xff1a; 第二种&#xff1a;集合推导式&#xff1a; 第三种&#xff1a;使用类型构造器&#xff1a; 集合是无…

ISIS多区域配置

一、什么是ISIS多区域 ISIS&#xff08;Intermediate System to Intermediate System&#xff09;多区域是指网络被划分为多个逻辑区域&#xff08;Areas&#xff09;&#xff0c;不同区域之间通过特定的ISIS路由器&#xff08;Level-1-2&#xff09;进行路由交互。多区域设计提…

2025-04-04 Unity 网络基础5——TCP分包与黏包

文章目录 1 分包与黏包2 解决方案2.1 数据接口2.2 定义消息2.3 NetManager2.4 分包、黏包处理 3 测试3.1 服务端3.2 客户端3.3 直接发送3.4 黏包发送3.5 分包发送3.6 分包、黏包发送3.7 其他 1 分包与黏包 ​ 分包、黏包指在网络通信中由于各种因素&#xff08;网络环境、API …

chromium魔改——绕过无限debugger反调试

在进行以下操作之前&#xff0c;请确保已完成之前文章中提到的 源码拉取及编译 部分。 如果已顺利完成相关配置&#xff0c;即可继续执行后续操作。 在浏览器中实现“无限 debugger”的反调试技术是一种常见的手段&#xff0c;用于防止他人通过开发者工具对网页进行调试或逆向…

JS dom修改元素的style样式属性

1通过样式属性修改 第三种 toggle有就删除 没就加上

灭火器离位检测:智能视觉守护安全

利用视觉分析实现明火检测&#xff1a;技术、功能与应用 一、背景 清明节期间&#xff0c;兰州市连续发生多起因祭祖烧纸引发山火的警情&#xff0c;如七里河区魏岭乡赵某某等人上坟烧纸未妥善处理烛火引燃杂草&#xff0c;导致3人烧伤&#xff1b;七里河区彭家坪石板山村村民…

网络:华为数通HCIA学习:IP路由基础

华为HCIA学习 IP路由基础路由协议或路由种类以及对应路由的优先级按工作区域分类&#xff1a;按工作机制及算法分类&#xff1a;路由的优先级路由器选择最优路由的顺序是什么? 前言自治系统LAN和广播域路由选路IP路由表路由度量建立路由表最长匹配原则路由器转发数据包总结 IP…

多线程开发中List的使用

由于ArrayList在多线程高并发情况下是不安全的&#xff0c;因此要慎用&#xff0c;那么此时如果涉及到集合操作&#xff0c;应该怎么选&#xff1a; 方案一&#xff1a;Vector: 特点&#xff1a;通过给所有方法都用 synchronized 修饰从而保证线程安全&#xff0c; 缺点&…