用于创建模块化单体Rust后端应用程序的模板


这是一个用于创建模块化单体Rust后端应用程序的模板。

架构

模板采用模块化整体架构,包含以下板条箱:

  • api:处理Web API层(路由、处理程序、中间件)。
  • db:管理所有数据库交互(存储库,服务)。
  • core:包含核心业务逻辑和数据模型。
  • auth:封装身份验证和授权逻辑。
如何使用此模板
  1. 克隆此资料档案库。
  2. 使用项目名称运行安装脚本:./setup.sh 举例来说:./setup.sh my-todo-app
  3. 脚本将用您的项目名称替换所有占位符。
  4. (可选)重新设置crates目录中的目录,以匹配您的项目名称。例如,将PROJECT_NAME-api重命名为my-todo-app-api。
  5. 开始编码!
API文档

Swagger UI(交互式)

  • 网址:http://localhost:8080/api/v1/docs/
  • 特性:交互式API测试、请求/响应示例、模式验证
  • 最适合:测试端点,理解请求格式
ReDoc(清洁文档)
  • 网址:http://localhost:8080/api/v1/docs/redoc
  • 特点:清晰、可读的文档,带有搜索功能
  • 最适合:阅读API文档,集成规划
OpenAPI规范
  • JSON格式:http://localhost:8080/api/v1/docs/openapi.json
  • YAML格式:http://localhost:8080/api/v1/docs/openapi.yaml
  • 用于:代码生成,导入到API工具