Bruno GaoandQwen-Coder
2fd1eb59ab
- Create SECURITY.md with vulnerability disclosure policy - Create docs/README.md as documentation index page - Create docs/observability.md with metrics/logs/traces/alerting/SLO specs - Create docs/runbook.md with troubleshooting scenarios (RB-01 to RB-05) - Create docs/security.md with security design and compliance - Create docs/release.md with versioning and rollback strategies - Create docs/database.md with database design and migration strategy - Create docs/adr/0005-cache-error-handler.md for cache error handling ADR - Update README.md with documentation index section - Update docs/architecture.md to update B-7 rule and add trust boundary section - Create docs/api-guide.md with API specifications - Fix method names in OrderDao.java to match OrderMapper interface - Add Spring Boot Actuator dependency to tmpl-infrastructure - Fix Redis ping method in RedisHealthContributor.java - Fix syntax errors and method names in OrderAppService.java Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
37 lines
2.1 KiB
Markdown
37 lines
2.1 KiB
Markdown
# Java 21 Service Template
|
|
|
|
A production-ready Java 21 service template with Spring Boot 3.4+, Clean Architecture, multi-tenancy, and comprehensive documentation.
|
|
|
|
## Documentation
|
|
|
|
Complete project documentation is available in the [`docs/`](docs/README.md) directory, covering architecture, API specifications, security, database, deployment, observability, operations manuals, release processes, development guidelines, configuration, testing, and architectural decision records.
|
|
|
|
| Core Documentation | Description |
|
|
|----------|------|
|
|
| [Architecture Design](docs/architecture.md) | Layered architecture, ArchUnit rules, multi-tenancy |
|
|
| [API Guide](docs/api-guide.md) | Endpoints, request/response formats, error codes |
|
|
| [Security Design](docs/security.md) | Authentication, authorization, tenant trust boundaries, compliance |
|
|
| [Database](docs/database.md) | Schema, indexing strategies, Flyway migration specs |
|
|
| [Observability](docs/observability.md) | Metrics, logging, tracing, alerting, SLO/SLA |
|
|
| [Operations Manual](docs/runbook.md) | Troubleshooting guides |
|
|
| [Deployment](docs/deployment.md) | Docker, Kubernetes, Kustomize |
|
|
| [Release Process](docs/release.md) | Versioning, release flows, rollback strategies |
|
|
| [Development Guide](docs/development.md) | Local environment, IDE, debugging |
|
|
| [Configuration Reference](docs/configuration.md) | Profiles, properties, environment variables |
|
|
| [Testing](docs/testing.md) | Test layers, Testcontainers, ArchUnit rules, quality gates |
|
|
| [ADR](docs/adr/) | Architectural Decision Records |
|
|
| [Vulnerability Disclosure](SECURITY.md) | Security vulnerability reporting channels and response SLA |
|
|
|
|
## Quick Start
|
|
|
|
For detailed setup instructions, see [development.md](docs/development.md).
|
|
|
|
## Features
|
|
|
|
- Java 21 with Virtual Threads
|
|
- Spring Boot 3.4+ with Clean Architecture (Hexagonal/Ports & Adapters)
|
|
- Multi-tenant SaaS architecture with strict tenant isolation
|
|
- Comprehensive documentation set
|
|
- ArchUnit-enforced architecture rules
|
|
- Production-ready observability and security
|
|
- Docker and Kubernetes deployment ready |