使用 Gorilla Mux 和 CockroachDB 编写可维护 RESTful API(中)

简介: 本文将使用功能强大的 Gorilla Mux、GORM 和 CockroachDB 编写可维护 RESTful API。

2 项目介绍

2.1 项目功能

本文创建一个应用是一个简单的 RESTful API 服务器:线上书店,它将公开书籍的访问和操作,主要包括如下功能:


  • 创建一本书籍
  • 获取书籍清单
  • 获取一本书籍信息
  • 更新已有书籍信息
  • 删除一本书籍

2.2 API 接口规范

为了实现上述的功能,我们的应用需要提供给外界如下的 API 接口规范:


  • 创建一本书籍:通过 /book 响应有效的 POST 请求
  • 获取书籍清单:通过 /books 响应有效的 GET 请求
  • 获取一本书籍:通过 /book/{id} 响应对应的 GET 请求
  • 更新一本书籍:通过 /book/{id} 响应对应的 PUT 请求
  • 删除一本书籍:通过 /book/{id} 响应对应的 DELETE 请求


通过 {id} 能够有效确定某本书籍。


网络异常,图片无法展示
|

2.3 项目结构

本文将创建一个非常简单的应用程序结构,这是本文使用的 mybook 应用的项目结构:

.
├── go.mod
├── go.sum
├── handlers.go
├── main.go
└── model
    ├── database.go
    └── model.go

2.4 安装项目依赖

安装 go get -u github.com/gorilla/mux,如下;


网络异常,图片无法展示
|


安装 go get -u gorm.io/gorm


安装 go get -u gorm.io/driver/postgres


网络异常,图片无法展示
|

3 应用功能设计

首先创建一个 mybook 的目录(应用文件夹),然后使用 go mod init mybook


接着在其中创建我们的 model 文件夹,接下来,在 model 文件夹下新建一个 model.go 文件。

3.1 model.go

我们需要设计出 book 模型,这里即将使用 GORM 进行创建,编写我们的 model.go 函数:

package model
import (
  "gorm.io/gorm"
)
type Book struct {
  gorm.Model
  ID          string  `json:"id"`
  Name        string  `json:"name"`
  Author      string  `json:"author"`
  Description string  `json:"description"`
  Price       float64 `json:"price"`
  Category    string  `json:"category"`
}


如上所示,书籍的结构体中进行简单设计包含 id(ID)、书名(Name)、作者(Author)、书籍描述(Description)、价格(Price)和类别(Category)。

3.2 database.go

该程序将创建数据库连接,需要使用到 postgresql://root@localhost:26257/defaultdb?sslmode=disable 传入到 gorm.Open() 的连接参数中,代码如下:

package model
import (
  "log"
  "time"
  "gorm.io/driver/postgres"
  "gorm.io/gorm"
)
func SetupDB() (*gorm.DB, error) {
  dsn := "postgresql://root@localhost:26257/defaultdb?sslmode=disable"
  db, err := gorm.Open(postgres.Open(dsn), &gorm.Config{})
  if err != nil {
    log.Fatal("can't connect to database", err)
  }
  var now time.Time
  db.Raw("SELECT NOW()").Scan(&now)
  log.Println(now)
  if err = db.AutoMigrate(&Book{}); err != nil {
    log.Println(err)
  }
  return db, err
}
相关文章
|
3天前
|
JSON 缓存 JavaScript
深入浅出:使用Node.js构建RESTful API
在这个数字时代,API已成为软件开发的基石之一。本文旨在引导初学者通过Node.js和Express框架快速搭建一个功能完备的RESTful API。我们将从零开始,逐步深入,不仅涉及代码编写,还包括设计原则、最佳实践及调试技巧。无论你是初探后端开发,还是希望扩展你的技术栈,这篇文章都将是你的理想指南。
|
6天前
|
存储 API 数据库
使用Python和Flask构建简单的RESTful API
使用Python和Flask构建简单的RESTful API
|
6天前
|
JSON 关系型数据库 测试技术
使用Python和Flask构建RESTful API服务
使用Python和Flask构建RESTful API服务
|
11天前
|
JSON JavaScript API
深入浅出Node.js:从零开始构建RESTful API
【10月更文挑战第39天】 在数字化时代的浪潮中,API(应用程序编程接口)已成为连接不同软件应用的桥梁。本文将带领读者从零基础出发,逐步深入Node.js的世界,最终实现一个功能完备的RESTful API。通过实践,我们将探索如何利用Node.js的异步特性和强大的生态系统来构建高效、可扩展的服务。准备好迎接代码和概念的碰撞,一起解锁后端开发的新篇章。
|
1天前
|
JSON API 开发者
深入理解RESTful API设计原则
在数字化时代,API已成为连接不同软件应用的桥梁。本文旨在探讨RESTful API设计的基本原则和最佳实践,帮助开发者构建高效、可扩展的网络服务接口。通过解析REST架构风格的核心概念,我们将了解如何设计易于理解和使用的API,同时保证其性能和安全性。
|
1天前
|
安全 测试技术 API
构建高效RESTful API:后端开发的艺术与实践####
在现代软件开发的浩瀚星空中,RESTful API如同一座桥梁,连接着前端世界的绚丽多彩与后端逻辑的深邃复杂。本文旨在探讨如何精心打造一款既高效又易于维护的RESTful API,通过深入浅出的方式,剖析其设计原则、实现技巧及最佳实践,为后端开发者提供一份实用的指南。我们不深入晦涩的理论,只聚焦于那些能够即刻提升API品质与开发效率的关键点,让你的API在众多服务中脱颖而出。 ####
8 0
|
12天前
|
JSON API 数据格式
淘宝 / 天猫官方商品 / 订单订单 API 接口丨商品上传接口对接步骤
要对接淘宝/天猫官方商品或订单API,需先注册淘宝开放平台账号,创建应用获取App Key和App Secret。之后,详细阅读API文档,了解接口功能及权限要求,编写认证、构建请求、发送请求和处理响应的代码。最后,在沙箱环境中测试与调试,确保API调用的正确性和稳定性。
|
24天前
|
供应链 数据挖掘 API
电商API接口介绍——sku接口概述
商品SKU(Stock Keeping Unit)接口是电商API接口中的一种,专门用于获取商品的SKU信息。SKU是库存量单位,用于区分同一商品的不同规格、颜色、尺寸等属性。通过商品SKU接口,开发者可以获取商品的SKU列表、SKU属性、库存数量等详细信息。
|
25天前
|
JSON API 数据格式
店铺所有商品列表接口json数据格式示例(API接口)
当然,以下是一个示例的JSON数据格式,用于表示一个店铺所有商品列表的API接口响应
|
1月前
|
编解码 监控 API
直播源怎么调用api接口
调用直播源的API接口涉及开通服务、添加域名、获取API密钥、调用API接口、生成推流和拉流地址、配置直播源、开始直播、监控管理及停止直播等步骤。不同云服务平台的具体操作略有差异,但整体流程简单易懂。