Add README

2026-07-13 09:48:40 +08:00
commit ff876bc860
1 changed files with 54 additions and 0 deletions
@@ -0,0 +1,54 @@
+# Patbond API
+
+Patbond API is a Spring Cloud microservice project.
+
+## Modules
+
+- `patbond-common`: shared response objects, DTOs, and common dependencies.
+- `patbond-user`: user service for user creation, profile lookup, and password verification.
+- `patbond-auth`: authentication service for registration and login.
+
+## Technology Stack
+
+- Java 8
+- Spring Boot 2.7.18
+- Spring Cloud 2021.0.9
+- Spring Cloud Alibaba 2021.0.6.0
+- Nacos
+- OpenFeign
+- RabbitMQ
+- Maven
+
+## Build
+
+```bash
+mvn compile
+```
+
+## Services
+
+### Auth Service
+
+- Application name: `patbond-auth`
+- Default port: `8081`
+- Register: `POST /auth/register`
+- Login: `POST /auth/login`
+
+### User Service
+
+- Application name: `patbond-user`
+- Default port: `8082`
+- Create user: `POST /internal/users`
+- Verify password: `POST /internal/users/verify-password`
+- Get user by id: `GET /internal/users/{id}`
+- Get user by username: `GET /internal/users/by-username/{username}`
+
+## Nacos
+
+Both services read the Nacos address from `NACOS_SERVER_ADDR`.
+
+Default value:
+
+```text
+127.0.0.1:8848
+```