logo
0
0
Login

Lead API Service

这是一个使用 Java 和 Spring Boot 框架构建的后端 API 服务。项目的核心功能是为销售线索(Leads)提供一套标准的增删改查(CRUD)管理接口。

核心功能

  • 分层架构: 遵循标准的 Controller-Service-Repository 分层设计,确保代码结构清晰、高内聚、低耦合,易于维护和扩展。
  • RESTful API: 提供一套设计良好的 RESTful 风格接口,用于线索的查询、筛选和统计。
  • DTO 模式: 通过数据传输对象(Data Transfer Objects)将 API 的公开“契约”与内部的数据库实体(Entity)完全解耦,保证了接口的稳定性和安全性。
  • 统一异常处理: 使用 @ControllerAdvice 实现全局异常处理,将错误处理逻辑从业务代码中分离,简化了 Controller 层的实现。
  • 自动化 API 文档: 集成了 SpringDoc OpenAPI (Swagger),在应用运行时自动生成交互式的 API 文档,方便前后端协作与接口测试。

技术栈

  • 语言: Java 17
  • 框架: Spring Boot 3
  • 数据持久化: Spring Data JPA, Hibernate
  • 数据库: SQLite
  • API 文档: SpringDoc OpenAPI 3

快速开始

  1. 环境准备:

    • 确保已安装 JDK 17 或更高版本。
    • 确保已安装 Apache Maven 3.x。
    • 重要: 本项目依赖一个位于绝对路径的 SQLite 数据库文件。请确保 E:/sqlite3/leadqlite.db 这个文件存在。如果不存在,应用在首次启动时会自动创建它。
  2. 安装依赖: 在项目根目录执行以下命令,下载所有必需的依赖。

    mvn clean install
  3. 运行服务: 执行以下命令启动应用。

    mvn spring-boot:run

    服务将启动在 http://localhost:8082

API 文档

服务启动后,可以直接在浏览器中访问以下地址,查看并使用交互式的 API 文档:

http://localhost:8082/swagger-ui.html