使用 Gin、FerretDB 和 oapi-codegen 构建博客 API-Golang-PHP中文网

首页

后端开发

Golang

使用 Gin、FerretDB 和 oapi-codegen 构建博客 API

WBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWB

Sep 05, 2024 pm 10:34 PM

Building a Blog API with Gin, FerretDB, and oapi-codegen

在本教程中，我们将逐步介绍使用 Go 为简单博客应用程序创建 RESTful API 的过程。我们将使用以下技术：

Gin：Go 的 Web 框架
FerretDB：兼容 MongoDB 的数据库
oapi-codegen：根据 OpenAPI 3.0 规范生成 Go 服务器样板的工具

设置项目

首先，让我们设置 Go 项目并安装必要的依赖项：

mkdir blog-api
cd blog-api
go mod init github.com/yourusername/blog-api
go get github.com/gin-gonic/gin
go get github.com/deepmap/oapi-codegen/cmd/oapi-codegen
go get github.com/FerretDB/FerretDB

定义API规范

在项目根目录中创建一个名为 api.yaml 的文件，并为我们的博客 API 定义 OpenAPI 3.0 规范：

openapi: 3.0.0
info:
  title: Blog API
  version: 1.0.0
paths:
  /posts:
    get:
      summary: List all posts
      responses:
        '200':
          description: Successful response
          content:
            application/json:    
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Post'
    post:
      summary: Create a new post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewPost'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Post'
  /posts/{id}:
    get:
      summary: Get a post by ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Post'
    put:
      summary: Update a post
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewPost'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Post'
    delete:
      summary: Delete a post
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Successful response

components:
  schemas:
    Post:
      type: object
      properties:
        id:
          type: string
        title:
          type: string
        content:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    NewPost:
      type: object
      required:
        - title
        - content
      properties:
        title:
          type: string
        content:
          type: string

生成服务器代码

现在，让我们使用 oapi-codegen 根据我们的 API 规范生成服务器代码：

oapi-codegen -package api api.yaml > api/api.go

此命令将创建一个名为 api 的新目录，并生成包含服务器接口和模型的 api.go 文件。

实施数据库层

创建一个名为 db/db.go 的新文件，以使用 FerretDB 实现数据库层：

package db

import (
    "context"
    "time"

    "go.mongodb.org/mongo-driver/bson"
    "go.mongodb.org/mongo-driver/bson/primitive"
    "go.mongodb.org/mongo-driver/mongo"
    "go.mongodb.org/mongo-driver/mongo/options"
)

type Post struct {
    ID primitive.ObjectID `bson:"_id,omitempty"`
    Title string `bson:"title"`
    Content string `bson:"content"`
    CreatedAt time.Time `bson:"createdAt"`
    UpdatedAt time.Time `bson:"updatedAt"`
}

type DB struct {
    client *mongo.Client
    posts *mongo.Collection
}

func NewDB(uri string) (*DB, error) {
    client, err := mongo.Connect(context.Background(), options.Client().ApplyURI(uri))
    if err != nil {
        return nil, err
    }

    db := client.Database("blog")
    posts := db.Collection("posts")

    return &DB{
        client: client,
        posts: posts,
    }, nil
}

func (db *DB) Close() error {
    return db.client.Disconnect(context.Background())
}

func (db *DB) CreatePost(title, content string) (*Post, error) {
    post := &Post{
        Title: title,
        Content: content,
        CreatedAt: time.Now(),
        UpdatedAt: time.Now(),
    }

    result, err := db.posts.InsertOne(context.Background(), post)
    if err != nil {
        return nil, err
    }

    post.ID = result.InsertedID.(primitive.ObjectID)
    return post, nil
}

func (db *DB) GetPost(id string) (*Post, error) {
    objectID, err := primitive.ObjectIDFromHex(id)
    if err != nil {
        return nil, err
    }

    var post Post
    err = db.posts.FindOne(context.Background(), bson.M{"_id": objectID}).Decode(&post)
    if err != nil {
        return nil, err
    }

    return &post, nil
}

func (db *DB) UpdatePost(id, title, content string) (*Post, error) {
    objectID, err := primitive.ObjectIDFromHex(id)
    if err != nil {
        return nil, err
    }

    update := bson.M{
        "$set": bson.M{
            "title": title,
            "content": content,
            "updatedAt": time.Now(),
        },
    }

    var post Post
    err = db.posts.FindOneAndUpdate(
        context.Background(),
        bson.M{"_id": objectID},
        update,
        options.FindOneAndUpdate().SetReturnDocument(options.After),
    ).Decode(&post)

    if err != nil {
        return nil, err
    }

    return &post, nil
}

func (db *DB) DeletePost(id string) error {
    objectID, err := primitive.ObjectIDFromHex(id)
    if err != nil {
        return err
    }

    _, err = db.posts.DeleteOne(context.Background(), bson.M{"_id": objectID})
    return err
}

func (db *DB) ListPosts() ([]*Post, error) {
    cursor, err := db.posts.Find(context.Background(), bson.M{})
    if err != nil {
        return nil, err
    }
    defer cursor.Close(context.Background())

    var posts []*Post
    for cursor.Next(context.Background()) {
        var post Post
        if err := cursor.Decode(&post); err != nil {
            return nil, err
        }
        posts = append(posts, &post)
    }

    return posts, nil
}

实施 API 处理程序

创建一个名为 handlers/handlers.go 的新文件来实现 API 处理程序：

package handlers

import (
    "net/http"
    "time"

    "github.com/gin-gonic/gin"
    "github.com/yourusername/blog-api/api"
    "github.com/yourusername/blog-api/db"
)

type BlogAPI struct {
    db *db.DB
}

func NewBlogAPI(db *db.DB) *BlogAPI {
    return &BlogAPI{db: db}
}

func (b *BlogAPI) ListPosts(c *gin.Context) {
    posts, err := b.db.ListPosts()
    if err != nil {
        c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
        return
    }

    apiPosts := make([]api.Post, len(posts))
    for i, post := range posts {
        apiPosts[i] = api.Post{
            Id: post.ID.Hex(),
            Title: post.Title,
            Content: post.Content,
            CreatedAt: post.CreatedAt,
            UpdatedAt: post.UpdatedAt,
        }
    }

    c.JSON(http.StatusOK, apiPosts)
}

func (b *BlogAPI) CreatePost(c *gin.Context) {
    var newPost api.NewPost
    if err := c.ShouldBindJSON(&newPost); err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
        return
    }

    post, err := b.db.CreatePost(newPost.Title, newPost.Content)
    if err != nil {
        c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
        return
    }

    c.JSON(http.StatusCreated, api.Post{
        Id: post.ID.Hex(),
        Title: post.Title,
        Content: post.Content,
        CreatedAt: post.CreatedAt,
        UpdatedAt: post.UpdatedAt,
    })
}

func (b *BlogAPI) GetPost(c *gin.Context) {
    id := c.Param("id")
    post, err := b.db.GetPost(id)
    if err != nil {
        c.JSON(http.StatusNotFound, gin.H{"error": "Post not found"})
        return
    }

    c.JSON(http.StatusOK, api.Post{
        Id: post.ID.Hex(),
        Title: post.Title,
        Content: post.Content,
        CreatedAt: post.CreatedAt,
        UpdatedAt: post.UpdatedAt,
    })
}

func (b *BlogAPI) UpdatePost(c *gin.Context) {
    id := c.Param("id")
    var updatePost api.NewPost
    if err := c.ShouldBindJSON(&updatePost); err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
        return
    }

    post, err := b.db.UpdatePost(id, updatePost.Title, updatePost.Content)
    if err != nil {
        c.JSON(http.StatusNotFound, gin.H{"error": "Post not found"})
        return
    }

    c.JSON(http.StatusOK, api.Post{
        Id: post.ID.Hex(),
        Title: post.Title,
        Content: post.Content,
        CreatedAt: post.CreatedAt,
        UpdatedAt: post.UpdatedAt,
    })
}

func (b *BlogAPI) DeletePost(c *gin.Context) {
    id := c.Param("id")
    err := b.db.DeletePost(id)
    if err != nil {
        c.JSON(http.StatusNotFound, gin.H{"error": "Post not found"})
        return
    }

    c.Status(http.StatusNoContent)
}

运行应用程序

在项目根目录中创建一个名为 main.go 的新文件来设置和运行应用程序：

package main

import (
    "log"

    "github.com/gin-gonic/gin"
    "github.com/yourusername/blog-api/api"
    "github.com/yourusername/blog-api/db"
    "github.com/yourusername/blog-api/handlers"
)

func main() {
    // Initialize the database connection
    database, err := db.NewDB("mongodb://localhost:27017")
    if err != nil {
        log.Fatalf("Failed to connect to the database: %v", err)
    }
    defer database.Close()

    // Create a new Gin router
    router := gin.Default()

    // Initialize the BlogAPI handlers
    blogAPI := handlers.NewBlogAPI(database)

    // Register the API routes
    api.RegisterHandlers(router, blogAPI)

    // Start the server
    log.Println("Starting server on :8080")
    if err := router.Run(":8080"); err != nil {
        log.Fatalf("Failed to start server: %v", err)
    }
}

测试 API

现在我们已经启动并运行了 API，让我们使用curl 命令来测试它：

创建一个新帖子：

curl -X POST -H "Content-Type: application/json" -d '{"title":"My First Post","content":"This is the content of my first post."}' http://localhost:8080/posts

列出所有帖子：

curl http://localhost:8080/posts

获取特定帖子（将 {id} 替换为实际帖子 ID）：

curl http://localhost:8080/posts/{id}

更新帖子（将 {id} 替换为实际帖子 ID）：

curl -X PUT -H "Content-Type: application/json" -d '{"title":"Updated Post","content":"This is the updated content."}' http://localhost:8080/posts/{id}

删除帖子（将 {id} 替换为实际帖子 ID）：

curl -X DELETE http://localhost:8080/posts/{id}

结论

在本教程中，我们使用 Gin 框架、FerretDB 和 oapi-codegen 构建了一个简单的博客 API。我们已经介绍了以下步骤：

设置项目并安装依赖项
使用 OpenAPI 3.0 定义 API 规范
使用 oapi-codegen 生成服务器代码
使用FerretDB实现数据库层
实现 API 处理程序
运行应用程序
使用curl命令测试API

该项目演示了如何利用代码生成和 MongoDB 兼容数据库的强大功能，使用 Go 创建 RESTful API。您可以通过添加身份验证、分页和更复杂的查询功能来进一步扩展此 API。

请记住在将此 API 部署到生产环境之前适当处理错误、添加适当的日志记录并实施安全措施。

需要帮助吗？

您是否面临着具有挑战性的问题，或者需要外部视角来看待新想法或项目？我可以帮忙！无论您是想在进行更大投资之前建立技术概念验证，还是需要解决困难问题的指导，我都会为您提供帮助。

提供的服务：

解决问题：通过创新的解决方案解决复杂问题。
咨询：为您的项目提供专家建议和新观点。
概念验证：开发初步模型来测试和验证您的想法。

如果您有兴趣与我合作，请通过电子邮件与我联系：hungaikevin@gmail.com。

让我们将挑战转化为机遇！

以上是使用 Gin、FerretDB 和 oapi-codegen 构建博客 API的详细内容。更多信息请关注PHP中文网其他相关文章！

声明

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系admin@php.cn

您如何使用PPROF工具分析GO性能？Mar 21, 2025 pm 06:37 PM

本文解释了如何使用PPROF工具来分析GO性能，包括启用分析，收集数据并识别CPU和内存问题等常见的瓶颈。

您如何在GO中编写单元测试？Mar 21, 2025 pm 06:34 PM

本文讨论了GO中的编写单元测试，涵盖了最佳实践，模拟技术和有效测试管理的工具。

如何编写模拟对象和存根以进行测试？Mar 10, 2025 pm 05:38 PM

本文演示了创建模拟和存根进行单元测试。它强调使用接口，提供模拟实现的示例，并讨论最佳实践，例如保持模拟集中并使用断言库。文章

如何定义GO中仿制药的自定义类型约束？Mar 10, 2025 pm 03:20 PM

本文探讨了GO的仿制药自定义类型约束。它详细介绍了界面如何定义通用功能的最低类型要求，从而改善了类型的安全性和代码可重复使用性。本文还讨论了局限性和最佳实践

解释GO反射软件包的目的。您什么时候使用反射？绩效有什么影响？Mar 25, 2025 am 11:17 AM

本文讨论了GO的反思软件包，用于运行时操作代码，对序列化，通用编程等有益。它警告性能成本，例如较慢的执行和更高的内存使用，建议明智的使用和最佳

您如何在GO中使用表驱动测试？Mar 21, 2025 pm 06:35 PM

本文讨论了GO中使用表驱动的测试，该方法使用测试用例表来测试具有多个输入和结果的功能。它突出了诸如提高的可读性，降低重复，可伸缩性，一致性和A

如何使用跟踪工具了解GO应用程序的执行流？Mar 10, 2025 pm 05:36 PM

本文使用跟踪工具探讨了GO应用程序执行流。它讨论了手册和自动仪器技术，比较诸如Jaeger，Zipkin和Opentelemetry之类的工具，并突出显示有效的数据可视化

Debian OpenSSL有哪些漏洞Apr 02, 2025 am 07:30 AM

OpenSSL，作为广泛应用于安全通信的开源库，提供了加密算法、密钥和证书管理等功能。然而，其历史版本中存在一些已知安全漏洞，其中一些危害极大。本文将重点介绍Debian系统中OpenSSL的常见漏洞及应对措施。DebianOpenSSL已知漏洞：OpenSSL曾出现过多个严重漏洞，例如：心脏出血漏洞(CVE-2014-0160):该漏洞影响OpenSSL1.0.1至1.0.1f以及1.0.2至1.0.2beta版本。攻击者可利用此漏洞未经授权读取服务器上的敏感信息，包括加密密钥等。

See all articles