Skip to content

Commit e9ebc09

Browse files
Remove database and API naming conventions
Removed database and API naming conventions sections from README.
1 parent 3cf0136 commit e9ebc09

1 file changed

Lines changed: 1 addition & 19 deletions

File tree

README.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -26,28 +26,12 @@
2626

2727
<img width="1478" height="815" alt="Image" src="https://github.com/user-attachments/assets/8c36a44c-4e4d-4128-9ef3-c9ca59203e38" />
2828

29-
## 🏗 Database Convention
30-
31-
데이터 일관성과 유지보수를 위해 아래 네이밍 규칙을 엄격히 준수합니다.
32-
33-
- **Table Naming**: Prefix를 사용하지 않으며, **단수형****snake_case**를 사용합니다.
34-
- _Example:_ `meeting`, `meeting_purpose`
35-
- **Column Naming**: **snake_case**를 사용합니다.
36-
- _Example:_ `created_at`, `updated_at`
37-
- **Boolean Column**: `is_` prefix 사용을 권장합니다.
38-
- _Example:_ `is_deleted`, `is_active`
39-
4029
### 📊 Entity Relationship Diagram (ERD)
4130

4231
<img width="688" height="531" alt="Image" src="https://github.com/user-attachments/assets/7fe10a00-b2b7-4bc3-9d9a-e5d1971a9554" />
4332

4433
## 🚀 API Specification
4534

46-
### 🏷 API Naming Rule
47-
48-
- **Format**: `/<domain>/<resource>/<action>`
49-
- **Convention**: 소문자 및 kebab-case 사용
50-
5135
### 📦 Common Response Format
5236

5337
모든 API 응답은 아래의 공통 규격을 따릅니다.
@@ -119,7 +103,7 @@
119103

120104
### Prerequisites
121105

122-
- JDK 17
106+
- JDK 26
123107
- MariaDB (Local or Docker)
124108

125109
### Installation & Run
@@ -151,5 +135,3 @@ git clone [https://github.com/SWYP-mingling/Backend.git](https://github.com/SWYP
151135

152136
상세한 API 명세 및 테스트는 아래 Swagger UI 링크를 참조하세요.
153137
👉 **[Mingling Swagger UI 바로가기](https://test-api.mingling.kr/swagger-ui/index.html)**
154-
155-
```

0 commit comments

Comments
 (0)