项目简介
本项目是基于 NestJS 框架构建的博客 RESTful API 服务,为博客相关业务提供稳定、规范且功能丰富的接口支持。
项目的主要特性和功能
- 接口规范:定义了详细的 HTTP 状态码和数据特征码,方便开发与调试。
- 数据模型:具备通用扩展字段,支持自定义扩展;各表重要字段明确,可建立数据表关系;数据组成形式多样,涵盖真实数据、计算数据、虚拟数据和第三方数据。
- 应用结构清晰
- 入口明确:由
main.ts
启动程序,app.module.ts
聚合业务模块,app.controller.ts
作为根控制器,app.config.ts
配置参数,app.environment.ts
管理全局环境变量。 - 请求处理流程完善:请求经中间件、守卫、拦截器、管道、控制器和服务等环节处理,最后进行数据格式化和异常捕获。
- 鉴权机制严格:对高级操作和部分 GET 请求鉴权,根据不同情况校验 Token。
- 参数校验严格:对用户请求参数进行合法性校验,拦截不合法或无权限请求。
- 错误处理全面:通过错误过滤器捕获请求处理中的异常。
- 拦截器和装饰器丰富:实现缓存、数据转换、异常捕获和日志记录等功能,以及配置缓存和输出规范化信息等扩展。
- 入口明确:由
- 核心辅助模块实用:提供数据库连接、缓存操作、搜索引擎实时更新、评论过滤、邮件发送、IP 地理查询和第三方云存储等辅助服务。
- 支持 Google 相关服务:可配置 Google Indexing API、Google Auth 和 Google Analytics Embed API。
安装使用步骤
假设已下载本项目的源码文件,可按以下步骤操作:
1. 安装依赖:在项目根目录下执行 yarn
命令。
2. 开发模式启动:执行 yarn start:dev
命令,启动开发服务器。
3. 测试
- 代码检查:执行 yarn lint
命令。
- 单元测试:执行 yarn test
命令。
- 端到端测试:执行 yarn test:e2e
命令。
- 测试覆盖率:执行 yarn test:cov
命令。
- 测试监听:执行 yarn test:watch
命令。
4. 构建项目:执行 yarn build
命令,生成生产环境代码。
5. 生产环境运行:执行 yarn start:prod
命令,启动生产环境服务器。
6. 更新 GEO IP 库数据:执行 yarn updategeodb
命令。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】