使用 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
}
相关文章
|
6天前
|
JSON 前端开发 API
打造高效后端:RESTful API 设计的最佳实践
【9月更文挑战第14天】在数字化时代,后端开发是构建强大、灵活和可维护应用程序的基石。本文将深入探讨如何设计高效的RESTful API,包括清晰的资源定义、合理的HTTP方法使用、URL结构规划、状态码的准确返回以及数据格式的设计。通过这些实践,开发者能够创建出既符合行业标准又易于维护和扩展的API,为前端提供强大的数据支持,确保整个应用的稳定性和性能。
141 74
|
1天前
|
JSON API 数据格式
深入浅出:使用Python实现一个简单的RESTful API
【8月更文挑战第51天】本文将引导读者理解RESTful API的基本原理,并通过一个简易的实例展示如何利用Python的Flask框架快速搭建一个RESTful服务。文章以通俗易懂的语言,结合代码示例,逐步讲解API的设计、实现和测试过程,旨在帮助初学者掌握RESTful API的开发方法。
25 11
|
6天前
|
XML API 开发者
掌握RESTful API设计的艺术
【9月更文挑战第14天】在数字化时代,APIs如同一座座桥梁,连接着不同的软件系统和服务。本文将深入探讨如何设计高效、可维护且易于理解的RESTful API,同时提供实际代码示例,帮助开发者构建更加稳固和灵活的后端服务。
30 11
|
9天前
|
Go API 开发者
深入探讨:使用Go语言构建高性能RESTful API服务
在本文中,我们将探索Go语言在构建高效、可靠的RESTful API服务中的独特优势。通过实际案例分析,我们将展示Go如何通过其并发模型、简洁的语法和内置的http包,成为现代后端服务开发的有力工具。
|
2天前
|
API 网络架构 开发者
探索后端开发:RESTful API设计的艺术
【9月更文挑战第18天】在数字化时代的浪潮中,后端开发如同搭建一座座坚固的桥梁,连接用户与数据的无限可能。本文将深入浅出地探讨RESTful API设计的精髓,从理论基础到实践应用,带领读者领略API设计的艺术。我们将以代码示例为灯塔,照亮理解之路,但
|
8天前
|
JSON API 数据库
使用Python和Flask构建简单的RESTful API
使用Python和Flask构建简单的RESTful API
16 6
|
11天前
|
设计模式 测试技术 API
Micronaut魔法书:揭秘构建超光速RESTful API的绝密技术!
【9月更文挑战第10天】在现代Web开发中,构建RESTful API至关重要。Micronaut作为一款轻量级框架,能够快速创建高效API。本文探讨使用Micronaut构建RESTful API的最佳设计模式与实践,涵盖注解(如`@Controller`、`@Get`)、代码组织、REST原则、数据验证及测试等方面,帮助开发者构建结构清晰、可维护性强的API服务。示例代码展示了如何使用Micronaut实现用户管理API,强调了良好设计模式的重要性。
25 3
|
3天前
|
存储 JavaScript NoSQL
深入浅出后端开发:构建你的第一个RESTful API
【9月更文挑战第17天】在数字时代的浪潮中,后端开发是支撑起整个互联网的骨架。本文将引导读者了解后端开发的基本概念,并通过一个实际的代码示例,展示如何从零开始构建一个简单的RESTful API。我们将一起探索API设计的哲学、选择合适的后端语言和框架,以及实现数据存储和接口测试的过程。无论你是编程新手,还是希望扩展你的技术栈,这篇文章都将为你提供一次全面而深入的后端开发之旅。
15 0
|
17天前
|
JSON 算法 安全
探索RESTful API设计的最佳实践
【9月更文挑战第2天】在数字化时代的浪潮中,后端开发如同搭建一座桥梁,连接着用户与数据的无限可能。本文将深入探讨如何打造高效、可维护的RESTful API,从资源命名到状态码的巧妙运用,每一个细节都隐藏着提升用户体验的智慧。你将学会如何在浩瀚的代码海洋中,用简洁明了的设计原则,引领用户安全抵达数据的彼岸。让我们一起启航,探索API设计的奥秘,让后端开发成为艺术与科学的完美结合。
|
2月前
|
机器学习/深度学习 API iOS开发
探索iOS开发中的SwiftUI框架深入理解RESTful API设计原则与最佳实践
【7月更文挑战第30天】本文深入探讨了SwiftUI框架在iOS开发中的应用,分析了其对用户界面构建的简化方法及性能优化。通过比较传统UI构建方式与SwiftUI的差异,揭示了SwiftUI如何提高开发效率和用户体验。文章还讨论了SwiftUI在实际项目中的集成策略,并展望了其未来的发展方向。 【7月更文挑战第30天】在数字时代的浪潮中,RESTful API如同一座桥梁,连接着不同的软件系统。本文将探讨RESTful API的核心设计原则,揭示其背后的哲学思想,并通过实例分析展示如何将这些原则应用于实际开发中。我们将从资源定位、接口一致性到HTTP方法的恰当使用,逐一剖析,旨在为开发者提供
48 1