codeship404/awd-nestjs

NestJS图书库API

https://nestjs.com/
https://github.com/BugShooter/awd-nestjs-book-library/actions/workflows/ci.yml

概述

本项目是“高级Web开发”训练营挑战的一部分，专注于构建符合OpenAPI规范的NestJS图书库API，支持图书记录的创建、读取、更新和删除（CRUD）操作，帮助开发者学习NestJS框架的核心功能与最佳实践。

核心功能

• 图书CRUD操作：实现图书的创建、查询（单本/全部）、更新、删除功能
• OpenAPI文档：集成Swagger生成API文档，便于测试与对接
• 数据验证：通过DTO（数据传输对象）确保请求数据合规
• 测试支持：提供单元测试、端到端测试及覆盖率报告
• Docker化：包含Dockerfile及部署指南，支持容器化运行

使用场景

• 学习NestJS框架的基础API开发流程
• 作为Web开发训练营的实践项目
• 快速搭建图书管理系统的后端API原型
• 掌握Docker容器化部署NestJS应用的方法

配置说明

项目设置

bash
npm install

编译与运行

bash
# 开发模式
npm run start

# 监听模式（代码变更自动重启）
npm run start:dev

# 生产模式
npm run start:prod

运行测试

bash
# 单元测试
npm run test

# 端到端测试
npm run test:e2e

# 测试覆盖率报告
npm run test:cov

Docker部署示例

构建镜像

bash
docker build -t codeship404/awd-nestjs .

运行容器

bash
docker run -p 3000:3000 codeship404/awd-nestjs

推送至Docker Hub

1. 登录Docker Hub：

bash
docker login

2. 标记镜像：

bash
docker tag codeship404/awd-nestjs codeship404/awd-nestjs:latest

3. 推送镜像：

bash
docker push codeship404/awd-nestjs:latest

资源参考

• https://docs.nestjs.com
• NestJS ***社区
• https://courses.nestjs.com/
• https://devtools.nestjs.com

许可协议

本项目基于MIT许可协议开源，详情见https://github.com/nestjs/nest/blob/master/LICENSE%E3%80%82

注意事项

• Docker Hub仓库名称需使用全小写字母，避免推送失败
• 使用COPY src ./src确保源码目录结构正确
• 生产环境建议使用多阶段构建减小镜像体积
• 启用全局验证管道确保请求数据合规
• 使用plainToClass转换响应数据至DTO格式