跳到主要内容

整洁代码示例

Github StackBlitz

这是一个使用 Fiber 框架 (https://fiber.org.cn/) 和 PostgreSQL 数据库构建的 RESTful API 示例。

整洁代码描述

整洁代码是一种编写易于理解、维护和扩展的代码的理念和实践集合。整洁代码的关键原则包括

  • 可读性:代码应易于阅读和理解。
  • 简洁性:避免不必要的复杂性。
  • 一致性:遵循一致的编码标准和规范。
  • 模块化:将代码分解成小的、可重用和独立的模块。
  • 可测试性:编写易于测试的代码。

这个 Fiber 应用是整洁代码的一个很好的示例,因为

  • 模块化结构:代码被组织成不同的模块,使其易于导航和理解。
  • 关注点分离明确:应用程序的不同部分(例如,路由、处理器、服务)清晰地分离,使代码库更易于维护和扩展。
  • 错误处理:实现了适当的错误处理,以确保应用程序行为可预测。

开始

  1. 构建并启动容器

    docker compose up --build
  2. 应用程序现在应该正在运行,可以通过 http://localhost:3000 访问。

接口

  • GET /api/v1/books: 获取所有书籍列表。

    curl -X GET http://localhost:3000/api/v1/books
  • POST /api/v1/books: 向集合中添加一本新书。

    curl -X POST http://localhost:3000/api/v1/books \
    -H "Content-Type: application/json" \
    -d '{"title":"Title"}'