[API 응답 개선] ApiResponseDto에 success 필드 추가로 성공/실패 여부 명확화. ApiResponseCode에 COMMON_CODE_DUPLICATE 추가 및 관련 메시지 수정. CommonCodeServiceImpl에서 중복 코드 예외 처리 개선.
This commit is contained in:
16
README.md
16
README.md
@@ -49,6 +49,7 @@ src/main/java/com/bio/bio_backend/
|
||||
|
||||
```java
|
||||
public class ApiResponseDto<T> {
|
||||
private boolean success; // 성공/실패 여부 (true/false)
|
||||
private int code; // HTTP 상태 코드
|
||||
private String message; // 응답 메시지 (ApiResponseCode enum 값)
|
||||
private String description; // 응답 설명
|
||||
@@ -56,12 +57,23 @@ public class ApiResponseDto<T> {
|
||||
}
|
||||
```
|
||||
|
||||
#### 상수 정의
|
||||
|
||||
```java
|
||||
public class ApiResponseDto<T> {
|
||||
private static final boolean SUCCESS = true;
|
||||
private static final boolean FAIL = false;
|
||||
// ... 필드들
|
||||
}
|
||||
```
|
||||
|
||||
#### 응답 예시
|
||||
|
||||
**성공 응답 (201 Created)**
|
||||
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"code": 201,
|
||||
"message": "COMMON_SUCCESS_CREATED",
|
||||
"description": "Created successfully",
|
||||
@@ -77,6 +89,7 @@ public class ApiResponseDto<T> {
|
||||
|
||||
```json
|
||||
{
|
||||
"success": false,
|
||||
"code": 409,
|
||||
"message": "USER_ID_DUPLICATE",
|
||||
"description": "User ID already exists"
|
||||
@@ -131,7 +144,8 @@ public enum ApiResponseCode {
|
||||
|
||||
- **모든 API 응답**: `ApiResponseDto<T>`로 감싸서 반환
|
||||
- **공용 응답 코드**: `COMMON_` 접두사로 시작하는 범용 코드 사용
|
||||
- **일관된 구조**: `code`, `message`, `description`, `data` 필드로 표준화
|
||||
- **일관된 구조**: `success`, `code`, `message`, `description`, `data` 필드로 표준화
|
||||
- **성공/실패 구분**: `success` 필드로 명확한 성공/실패 여부 전달
|
||||
- **제네릭 활용**: `<T>`를 통해 다양한 데이터 타입 지원
|
||||
|
||||
### 3. JWT 인증 시스템
|
||||
|
Reference in New Issue
Block a user