tech-doc.md

项目文档

api接口文档

常用命令

为方便日常开发，项目预置了部分常用脚本，可以帮助项目成员快速完成一些常见的任务。

静态代码检查

良好的编码风格和编码格式是高质量软件的基础，时刻注意编码格式和风格是推荐的优秀实践。如需快速获得编码风格的问题反馈，请使用以下命令：

./scripts/check-static

本地CI检查

为了持续集成，项目提供了必要的基础设施，质量门禁便是其中之一。质量门禁提供了静态代码检查、单元测试、集成测试、测试覆盖率等各项质量检查项，以帮助团队守住质量基线，为持续集成提供必要的基础。 开发每次推送代码至代码库前务必在本地执行质量门禁检查，并且在代码被推送至代码仓库后，构建服务器也会触发质量门禁。本地执行质量检测直接执行以下命令：

./scripts/check-all

如果计算机资源充足（多核CPU、大内存、SSD），可使用并行检查缩短反馈时间：

./scripts/check-all-parallel

REFERENCE DOCUMENTATION

For further reference, please consider the following sections:

• Official Gradle documentation
• Spring Boot Gradle Plugin Reference Guide
• Create an OCI image
• Testcontainers MongoDB Module Reference Guide
• Quartz Scheduler
• Spring REST Docs
• Spring Configuration Processor
• Spring Web
• Spring Data JPA
• Flyway Migration
• Spring Data MongoDB
• Spring Boot Actuator
• Testcontainers

GUIDES

The following guides illustrate how to use some features concretely:

• Building a RESTful Web Service
• Serving Web Content with Spring MVC
• Building REST services with Spring
• Accessing Data with JPA
• Accessing Data with MongoDB
• Building a RESTful Web Service with Spring Boot Actuator

ADDITIONAL LINKS

These additional references should also help you:

• Gradle Build Scans – insights for your project's build