readme 업데이트 - 데이터 호출방식 가이드 추가

This commit is contained in:
kangsunlee
2025-06-07 16:50:29 +09:00
parent 9039747a81
commit af6bb56acb

View File

@@ -135,6 +135,47 @@ InitAdminData, InitUriFrontData 등 *ApplicationRunner* 구현체에서 내용
* embedded : 내장 DB(H2 등)일 경우에만 실행
* never : SQL 스크립트를 실행하지 않음
## 데이터 호출 및 응답 처리 방식 가이드
> BO(Back Office)와 FO(Front Office) 화면에서는 기능에 따라 **Ajax 호출 방식**과 **서버 렌더링 방식(Server-Side Rendering, SSR)을** 구분하여 사용합니다.
### BO (Back Office: 관리자 화면)
- #### 📡 Ajax 호출 방식 (REST API, JSON 응답)
다음 기능은 Ajax를 통해 REST API(JSON)를 호출합니다
| 기능 | 메서드 | URI | 예시 |
|------------|------------|------------------------------------|------------------------|
| 목록 조회 | GET | `/api/{resource-name}/list` | `/api/articles/list` |
| 등록 | POST | `/api/{resource-name}/create` | `/api/articles/create` |
| 수정 | PUT/PATCH | `/api/{resource-name}/update` | `/api/articles/update` |
| 삭제 | DELETE | `/api/{resource-name}/remove` | `/api/articles/remove` |
- #### 🖥️ 서버 렌더링 방식 (SSR)
상세 조회(view) 화면은 SSR 방식으로 처리합니다.
| 기능 | 메서드 | URI | 예시 |
|------------|--------|------------------------|---------------|
| 상세 조회 | GET | `/{resource-name}/{id}` | `/articles/1` |
---
### FO (Front Office: 사용자 화면)
- #### 📡 Ajax 호출 방식 (REST API, JSON 응답)
다음 기능은 Ajax 기반 REST API 호출로 처리합니다.
| 기능 | 메서드 | URI | 예시 |
|------|------------|-------------------------|--------------------------|
| 등록 | POST | `/api/{resource-name}/create` | `/api/articles/create` |
| 수정 | PUT/PATCH | `/api/{resource-name}/update` | `/api/articles/update` |
| 삭제 | DELETE | `/api/{resource-name}/remove` | `/api/articles/remove` |
- #### 🖥️ 서버 렌더링 방식 (SSR)
목록 및 상세 화면은 SSR 방식으로 처리할 수 있으며, 상황에 따라 선택적으로 사용합니다.
| 기능 | 메서드 | URI | 예시 |
|------------|--------|------------------------------|------------------------|
| 목록 조회 | GET | `/{resource-name}/list` | `/articles/list` |
| 상세 조회 | GET | `/{resource-name}/{id}` | `/articles/1` |
## LOG 생성 옵션
### logging.file.path