gin + es 实践 04

最新推荐文章于 2025-05-05 14:08:17 发布
最新推荐文章于 2025-05-05 14:08:17 发布
阅读量447 收藏 7
点赞数 13
分类专栏： Go-ES 文章标签： gin elasticsearch 大数据
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_73516381/article/details/147702127
版权

API 接口设计

Go-ES 项目提供了一套完整的 RESTful API，用于产品管理和搜索。本文档详细介绍了 API 的设计原则、接口定义和使用方法。

API 设计原则

本项目的 API 设计遵循以下原则：

  1. RESTful 风格：使用标准的 HTTP 方法表示操作类型
  2. 资源导向：API 路径以资源名词为中心
  3. JSON 格式：请求和响应均使用 JSON 格式
  4. 版本控制：API 路径包含版本号
  5. 统一错误处理：使用一致的错误响应格式
  6. 自文档化：使用 Swagger 注解自动生成 API 文档

API 基础信息

  • 基础路径：/api/v1
  • 内容类型：application/json
  • 认证方式：API Key（通过 Authorization 头）

API 端点概览

方法路径描述
POST/products创建产品
GET/products获取产品列表
GET/products/{id}获取产品详情
PUT/products/{id}更新产品
DELETE/products/{id}删除产品
GET/products/category/{category}获取指定类别产品
GET/products/search搜索产品
POST/products/reindex重建产品索引

API 详细说明

1. 创建产品

请求:

POST /api/v1/products
Content-Type: application/json

{
  "name": "示例产品",
  "description": "这是一个示例产品",
  "price": 99.99,
  "category": "电子产品",
  "tags": ["新品", "热销"]
}

响应:

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "name": "示例产品",
  "description": "这是一个示例产品",
  "price": 99.99,
  "category": "电子产品",
  "tags": ["新品", "热销"],
  "created_at": "2023-05-01T12:00:00Z",
  "updated_at": "2023-05-01T12:00:00Z"
}

处理逻辑:

func (h *ProductHandler) Create(c *gin.Context) {
    var req dto.CreateProductRequest
    if err := c.ShouldBindJSON(&req); err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"error": "无效的请求数据"})
        return
    }

    product, err := h.productAppService.CreateProduct(c.Request.Context(), &req)
    if err != nil {
        c.JSON(http.StatusInternalServerError, gin.H{"error": fmt.Sprintf("创建产品失败: %v", err)})
        return
    }

    c.JSON(http.StatusCreated, product)
}

2. 获取产品列表

请求:

GET /api/v1/products?page=1&size=10

响应:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "total": 100,
  "page": 1,
  "page_size": 10,
  "products": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "name": "示例产品",
      "description": "这是一个示例产品",
      "price": 99.99,
      "category": "电子产品",
      "tags": ["新品", "热销"],
      "created_at": "2023-05-01T12:00:00Z",
      "updated_at": "2023-05-01T12:00:00Z"
    },
    // ... 更多产品
  ]
}

处理逻辑:

func (h *ProductHandler) List(c *gin.Context) {
    page, _ := strconv.Atoi(c.DefaultQuery("page", "1"))
    size, _ := strconv.Atoi(c.DefaultQuery("size", "10"))

    products, err := h.productAppService.ListProducts(c.Request.Context(), page, size)
    if err != nil {
        c.JSON(http.StatusInternalServerError, gin.H{"error": fmt.Sprintf("获取产品列表失败: %v", err)})
        return
    }

    c.JSON(http.StatusOK, products)
}

3. 获取产品详情

请求:

GET /api/v1/products/f47ac10b-58cc-4372-a567-0e02b2c3d479

响应:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "name": "示例产品",
  "description": "这是一个示例产品",
  "price": 99.99,
  "category": "电子产品",
  "tags": ["新品", "热销"],
  "created_at": "2023-05-01T12:00:00Z",
  "updated_at": "2023-05-01T12:00:00Z"
}

处理逻辑:

func (h *ProductHandler) Get(c *gin.Context) {
    id := c.Param("id")
    if id == "" {
        c.JSON(http.StatusBadRequest, gin.H{"error": "产品ID不能为空"})
        return
    }

    product, err := h.productAppService.GetProduct(c.Request.Context(), id)
    if err != nil {
        if err.Error() == "产品不存在" {
            c.JSON(http.StatusNotFound, gin.H{"error": "产品不存在"})
            return
        }
        c.JSON(http.StatusInternalServerError, gin.H{"error": fmt.Sprintf("获取产品失败: %v", err)})
        return
    }

    c.JSON(http.StatusOK, product)
}

4. 搜索产品

请求:

GET /api/v1/products/search?q=手机&category=电子产品&page=1&size=10

响应:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "total": 5,
  "page": 1,
  "page_size": 10,
  "products": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "name": "高端智能手机",
      "description": "这是一款功能强大的智能手机",
      "price": 3999.99,
      "category": "电子产品",
      "tags": ["手机", "智能设备"],
      "created_at": "2023-05-01T12:00:00Z",
      "updated_at": "2023-05-01T12:00:00Z"
    },
    // ... 更多产品
  ]
}

处理逻辑:

func (h *ProductHandler) Search(c *gin.Context) {
    var searchReq dto.SearchProductRequest
    if err := c.ShouldBindQuery(&searchReq); err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"error": "无效的搜索参数"})
        return
    }

    products, err := h.productAppService.SearchProducts(c.Request.Context(), &searchReq)
    if err != nil {
        c.JSON(http.StatusInternalServerError, gin.H{"error": fmt.Sprintf("搜索产品失败: %v", err)})
        return
    }

    c.JSON(http.StatusOK, products)
}

请求与响应模型

请求模型

创建产品请求
// CreateProductRequest 创建产品请求
type CreateProductRequest struct {
    Name        string   `json:"name" binding:"required"`
    Description string   `json:"description"`
    Price       float64  `json:"price" binding:"required,gt=0"`
    Category    string   `json:"category" binding:"required"`
    Tags        []string `json:"tags"`
}
更新产品请求
// UpdateProductRequest 更新产品请求
type UpdateProductRequest struct {
    Name        string   `json:"name" binding:"required"`
    Description string   `json:"description"`
    Price       float64  `json:"price" binding:"required,gt=0"`
    Category    string   `json:"category" binding:"required"`
    Tags        []string `json:"tags"`
}
搜索产品请求
// SearchProductRequest 搜索产品请求
type SearchProductRequest struct {
    Keyword  string `form:"q"`
    Category string `form:"category"`
    Page     int    `form:"page,default=1"`
    PageSize int    `form:"size,default=10"`
}

响应模型

产品响应
// ProductResponse 产品响应
type ProductResponse struct {
    ID          string    `json:"id"`
    Name        string    `json:"name"`
    Description string    `json:"description"`
    Price       float64   `json:"price"`
    Category    string    `json:"category"`
    Tags        []string  `json:"tags"`
    CreatedAt   time.Time `json:"created_at"`
    UpdatedAt   time.Time `json:"updated_at"`
}
产品列表响应
// ProductListResponse 产品列表响应
type ProductListResponse struct {
    Total    int64            `json:"total"`
    Page     int              `json:"page"`
    PageSize int              `json:"page_size"`
    Products []ProductResponse `json:"products"`
}

错误处理

API 使用统一的错误响应格式：

{
  "error": "错误描述信息"
}

常见的错误响应包括：

  • 400 Bad Request: 请求参数无效
  • 404 Not Found: 请求的资源不存在
  • 500 Internal Server Error: 服务器内部错误

API 文档生成

本项目使用 Swagger 自动生成 API 文档。API 处理器中的注解如下所示：

// Create 创建产品
// @Summary 创建新产品
// @Description 创建一个新的产品并索引到Elasticsearch
// @Tags 产品
// @Accept  json
// @Produce  json
// @Param product body dto.CreateProductRequest true "产品信息"
// @Success 201 {object} dto.ProductResponse
// @Failure 400 {object} map[string]string "错误信息"
// @Failure 500 {object} map[string]string "错误信息"
// @Router /products [post]
func (h *ProductHandler) Create(c *gin.Context) {
    // 实现逻辑...
}

使用 Swagger 文档

  1. 启动应用后，访问 Swagger UI：
http://localhost:8080/swagger/index.html
  1. 在 Swagger UI 界面中可以:
    • 浏览所有 API 端点
    • 查看请求参数和响应格式
    • 直接在浏览器中测试 API

API 路由注册

所有 API 路由在 interfaces/api/router/router.go 中注册：

// SetupRouter 设置路由
func SetupRouter(engine *gin.Engine, productHandler *handler.ProductHandler) {
    // 设置中间件
    engine.Use(gin.Logger())
    engine.Use(gin.Recovery())
    engine.Use(middleware.Cors())

    // 添加Swagger
    engine.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))

    // API 路由组
    api := engine.Group("/api/v1")
    {
        // 产品相关路由
        products := api.Group("/products")
        {
            products.POST("", productHandler.Create)
            products.GET("", productHandler.List)
            products.GET("/:id", productHandler.Get)
            products.PUT("/:id", productHandler.Update)
            products.DELETE("/:id", productHandler.Delete)
            products.GET("/category/:category", productHandler.ListByCategory)
            products.GET("/search", productHandler.Search)
            products.POST("/reindex", productHandler.ReindexAll)
        }
    }
}

跨域处理

API 支持跨域请求，通过自定义中间件实现：

// Cors 添加CORS头
func Cors() gin.HandlerFunc {
    return func(c *gin.Context) {
        c.Writer.Header().Set("Access-Control-Allow-Origin", "*")
        c.Writer.Header().Set("Access-Control-Allow-Methods", "GET, POST, PUT, DELETE, OPTIONS")
        c.Writer.Header().Set("Access-Control-Allow-Headers", "Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization")
        c.Writer.Header().Set("Access-Control-Max-Age", "86400")

        // 处理OPTIONS请求
        if c.Request.Method == "OPTIONS" {
            c.AbortWithStatus(200)
            return
        }

        // 处理请求
        c.Next()
    }
}
go项目实战——构建Go+ES8企业级搜索微服务
e891377的专栏
04-15 421
【代码】go项目实战——构建Go+ES8企业级搜索微服务。
Go实战Gin+Vue+微服务打造秒杀商城配套代码
05-27
使用Prometheus和Grafana进行性能指标监控，ELK（Elasticsearch、Logstash、Kibana）堆栈进行日志收集和分析，以便于及时发现并解决问题。 这个项目涵盖了现代Web开发的多个关键领域，通过实践，可以提升对Go语言...
gin + es 实践 05
m0_73516381的博客
05-05 563
本文档提供了 Go-ES 项目的完整部署指南，包括环境准备、应用构建、数据库和 Elasticsearch 设置以及服务启动流程。
gin + es 实践 03
m0_73516381的博客
05-04 778
Go-ES 项目的一个核心特性是集成了 Elasticsearch 实现高效的全文搜索功能。本文将详细介绍项目中 Elasticsearch 的集成方式和关键实现点。
gin + es 实践 06
最新发布
m0_73516381的博客
05-05 665
本文档为 Go-ES 项目的开发指南，介绍了如何设置开发环境、代码规范、测试方法以及如何贡献和扩展本项目。
gin + es 实践 02
m0_73516381的博客
05-04 484
在 Go-ES 项目中，我们采用了领域驱动设计（DDD）方法论来构建产品管理系统的核心模型。
gin + es 实践 01
m0_73516381的博客
05-03 260
Go-ES 项目采用领域驱动设计（DDD）架构，目录结构清晰，各层次职责分明。
GO语言的实践项目GIN,GORM
2302_76581139的博客
11-30 811
经过了在青训营的学习之后，对于go语言我有了一些初步的认识，结合着网上的相关资料的学习，我上手完成了一个很小的功能实现，包含的框架有gin和gorm是go语言较为流行的网络框架和数据库管理框架。同时我还用到了jwt认证，Bcrypt 的密码加密存储和验证，保证系统的基本安全。经过了这次的学习，我认识到了go的简洁性，但是性能的优点我目前还未认识到，学习到了web的基础知识，只是刚开始初识web的构建，之后会学习更多的语法使用和原理解析，尝试制作更完整的内容。
集成 Logrus 到 Gin：打造高效的 Go Web 日志系统
一起coding，一起嗨。
09-06 1477
集成 Logrus 到 Gin：打造高效的 Go Web 日志系统
ElasticSearch与PostgreSQL的整合
AI天才研究院
01-25 777
1.背景介绍 1. 背景介绍 Elasticsearch 是一个基于 Lucene 库的搜索引擎，由 Elastic 公司开发。它是一个分布式、实时、高性能的搜索引擎，可以用于文本搜索、数据分析、日志分析等。PostgreSQL 是一个高性能、可扩展的关系型数据库管理系统，由 PostgreSQL Global Development Group 开发。 在现代应用中，数据量越来越大，传统的...
基于elasticsearch的电影搜索引擎
02-22
how to run？ # 安装中文分词插件ik # ...mini_todo——基于 go 语言的 todo restful-api 实践(gin+vue) mini_sms_classify——小型垃圾邮件分类系统（naive_bayes+flask+vue） mini_mnis
心理咨询系统源码：Gin+Gorm+Redis+MySQL读写分离架构
总结而言，该心理咨询系统源码集成了Gin、GORM、Redis和MySQL等多个技术栈，运用了现代Web开发中的多种实践，包括安全的用户鉴权、高效的读写分离、日志收集与分析、以及高效的容器化部署技术，是一个综合应用现代IT...
电子商城使用gin+gorm+redis+mysql的读写分离实现
ELK由Elasticsearch、Logstash和Kibana三个开源工具组成，它们共同为日志管理和分析提供了强大的解决方案。Elasticsearch用于日志存储和搜索，Logstash用于日志收集和处理，而Kibana提供了日志数据的可视化展示。 #...
（Go Gin）Gin学习笔记（二）：路由配置、基本路由、表单参数、上传单个文件、上传多个文件、浅扒路由原理
拔高、提升、创新！
04-30 1352
gin 框架中采用的路优酷是基于httprouter做的是一个高性能的 HTTP 请求路由器，适用于 Go 语言。它的设计目标是提供高效的路由匹配和低内存占用，特别适合需要高性能和简单路由的应用场景。主要特点…///
（Go Gin）Gin学习笔记（三）数据解析和绑定：结构体分析，包括JSON解析、form解析、URL解析，区分绑定的Bind方法
拔高、提升、创新！
04-30 878
bind或bindXXX函数（后文中我们统一都叫bind函数）的作用就是将，以方便后续业务逻辑的处理。
（Go Gin）Gin学习笔记（四）Gin的数据渲染和中间件的使用：数据渲染、返回JSON、浅.JSON()源码、中间件、Next()方法
拔高、提升、创新！
04-30 1344
我们在正常注册中间件时，会打断原有的运行流程，但是你可以在中间件函数内部添加Next()方法，这样可以让原有的运行流程继续执行，当原有的运行流程结束后再回来执行中间件内部的内容。​ c.Writer.WriteHeaderNow()还会写入文本流中。可以看到使用next后，正常执行流程中并没有获得到中间件设置的值。接口还提供了一个可以修改ContentType的方法。判断了传入的状态码是否符合正确的状态码，并返回。在内部封装时，只是标注了不同的render类型。再看一下其他返回的类型；
【计网】认识跨域，及其在go中通过注册CORS中间件解决跨域方案，go-zero、gin
m0_74282926的博客
04-28 1054
跨域是浏览器安全机制；处理跨域主要是设置HTTP响应头；gin自己可以写中间件或用；go-zero直接在配置里加Cors: true；OPTIONS预检请求一定要处理，否则请求直接失败。
（Go Gin）Gin学习笔记（五）会话控制与参数验证：Cookie使用、Sessions使用、结构体验证参数、自定义验证参数
拔高、提升、创新！
04-30 1181
import ("net/http""reflect"/*对绑定解析到结构体上的参数，自定义验证功能比如我们要对 name 字段做校验，要不能为空，并且不等于 admin ，类似这种需求，就无法 binding 现成的方法需要我们自己验证方法才能实现 官网示例（https://godoc.org/gopkg.in/go-playground/validator.v8#hdr-Custom_Functions）
OpenGL-ES 学习(15) ----纹理
小猪佩奇的博客
05-01 1353
现实生活中，纹理(Texture) 类似于游戏中皮肤的概念，最通常的作用是装饰3D物体，它像贴纸一样贴在物体的表面，丰富物体的表面和细节在OpenGL-ES开发中，纹理除了用于装饰物体表面，还可以用来作为存储数据的容器所以在OpenGL-ES中，纹理实际上是一个可以被采样的复杂数据集合，是GPU的图像数据结构，纹理分为 2D纹理、立方图纹理和 3D纹理2D纹理是OpenGL-ES中最常见和最常用的纹理形式，是一个表示图像数据的二维数组，纹理中一个单独的数据单元被称为纹素或者纹理像素立方图纹理(
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值