Skip to content

Commit

Permalink
refactor: Readme 수정 1차
Browse files Browse the repository at this point in the history
  • Loading branch information
nathanLYJ committed Oct 14, 2024
1 parent 4f4c228 commit 7b48e01
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ C- hatGPT 연동: 수업 중 실시간으로 질문할 수 있는 AI 기반 Q&A

#### 수강생 (Student)

| 엔드포인트 | 메서드 | 설명 | 인증 필요 |
| 엔드포인트 | 메서드 | 설명 | 인증|
|------------|--------|------|----------|
| `/api/accounts/student/register/` | `POST` | 새로운 수강생을 생성합니다. (회원가입) ||
| `/api/accounts/students/` | `GET` | 수강생 목록을 조회합니다. ||
Expand All @@ -87,7 +87,7 @@ C- hatGPT 연동: 수업 중 실시간으로 질문할 수 있는 AI 기반 Q&A

#### 강사 (Tutor)

| 엔드포인트 | 메서드 | 설명 | 인증 필요 |
| 엔드포인트 | 메서드 | 설명 | 인증|
|------------|--------|------|----------|
| `/api/accounts/tutors/` | `GET` | 강사 목록을 조회합니다. ||
| `/api/accounts/tutors/{id}/` | `GET` | 강사 정보를 조회합니다. ||
Expand All @@ -97,13 +97,13 @@ C- hatGPT 연동: 수업 중 실시간으로 질문할 수 있는 AI 기반 Q&A

#### 공통

| 엔드포인트 | 메서드 | 설명 | 인증 필요 |
| 엔드포인트 | 메서드 | 설명 | 인증|
|------------|--------|------|----------|
| `/api/accounts/password/reset/` | `POST` | 비밀번호를 재설정합니다. ||

### 이미지 (Image)

| 엔드포인트 | 메서드 | 설명 | 인증 필요 |
| 엔드포인트 | 메서드 | 설명 | 인증|
|------------|--------|------|----------|
| `/api/materials/images/upload/` | `POST` | 새로운 이미지를 업로드합니다. ||
| `/api/materials/images/` | `GET` | 모든 이미지를 가져옵니다. ||
Expand All @@ -114,7 +114,7 @@ C- hatGPT 연동: 수업 중 실시간으로 질문할 수 있는 AI 기반 Q&A

### 비디오 (Video)

| 엔드포인트 | 메서드 | 설명 | 인증 필요 |
| 엔드포인트 | 메서드 | 설명 | 인증 |
|------------|--------|------|----------|
| `/api/materials/videos/upload/` | `POST` | 새로운 비디오를 업로드합니다. ||
| `/api/materials/videos/` | `GET` | 모든 비디오를 가져옵니다. ||
Expand All @@ -125,14 +125,14 @@ C- hatGPT 연동: 수업 중 실시간으로 질문할 수 있는 AI 기반 Q&A

### 비디오 이벤트 데이터 (Video Event Data)

| 엔드포인트 | 메서드 | 설명 | 인증 필요 |
| 엔드포인트 | 메서드 | 설명 | 인증 |
|------------|--------|------|----------|
| `/api/materials/video-event-data/` | `POST` | 새로운 비디오 이벤트 데이터를 생성합니다. ||
| `/api/materials/users/{user_id}/videos/{video_id}/watch-history/` | `GET` | 특정 사용자의 특정 비디오 시청 기록을 조회합니다. ||

### 과목 (Course)

| 엔드포인트 | 메서드 | 설명 | 인증 필요 |
| 엔드포인트 | 메서드 | 설명 | 인증 |
|------------|--------|------|----------|
| `/api/courses/courses/` | `GET` | 모든 과목 목록을 조회합니다. ||
| `/api/courses/courses/` | `POST` | 새로운 과목을 생성합니다. | ✅ (staff) |
Expand All @@ -148,7 +148,7 @@ C- hatGPT 연동: 수업 중 실시간으로 질문할 수 있는 AI 기반 Q&A

### 커리큘럼 (Curriculum)

| 엔드포인트 | 메서드 | 설명 | 인증 필요 |
| 엔드포인트 | 메서드 | 설명 | 인증|
|------------|--------|------|----------|
| `/api/courses/curriculums/` | `GET` | 모든 커리큘럼 목록을 조회합니다. ||
| `/api/courses/curriculums/` | `POST` | 새로운 커리큘럼을 생성합니다. | ✅ (staff) |
Expand All @@ -164,7 +164,7 @@ C- hatGPT 연동: 수업 중 실시간으로 질문할 수 있는 AI 기반 Q&A

### 장바구니 (Cart)

| 엔드포인트 | 메서드 | 설명 | 인증 필요 |
| 엔드포인트 | 메서드 | 설명 | 인증|
|------------|--------|------|----------|
| `/api/payments/cart/` | `GET` | 사용자의 장바구니를 조회합니다. ||
| `/api/payments/cart/` | `POST` | 장바구니에 상품을 추가합니다. ||
Expand All @@ -173,14 +173,14 @@ C- hatGPT 연동: 수업 중 실시간으로 질문할 수 있는 AI 기반 Q&A

### 주문 (Order)

| 엔드포인트 | 메서드 | 설명 | 인증 필요 |
| 엔드포인트 | 메서드 | 설명 | 인증 |
|------------|--------|------|----------|
| `/api/payments/orders/` | `GET` | 사용자의 진행 중인 주문을 조회합니다. ||
| `/api/payments/orders/` | `POST` | 새로운 주문을 생성합니다. ||

### 청구 주소 (Billing Address)

| 엔드포인트 | 메서드 | 설명 | 인증 필요 |
| 엔드포인트 | 메서드 | 설명 | 인증 |
|------------|--------|------|----------|
| `/api/payments/billing-addresses/` | `GET` | 사용자의 모든 청구 주소를 조회합니다. ||
| `/api/payments/billing-addresses/` | `POST` | 새로운 청구 주소를 생성합니다. ||
Expand All @@ -190,15 +190,15 @@ C- hatGPT 연동: 수업 중 실시간으로 질문할 수 있는 AI 기반 Q&A

### 결제 (Payment)

| 엔드포인트 | 메서드 | 설명 | 인증 필요 |
| 엔드포인트 | 메서드 | 설명 | 인증 |
|------------|--------|------|----------|
| `/api/payments/payments/` | `POST` | 결제를 생성하고 카카오페이 결제를 요청합니다. ||
| `/api/payments/payments/` | `GET` | 카카오페이 결제 결과를 처리합니다. ||
| `/api/payments/payments/{order_id}/cancel/` | `DELETE` | 결제를 취소하고 환불을 처리합니다. ||

### 영수증 (Receipt)

| 엔드포인트 | 메서드 | 설명 | 인증 필요 |
| 엔드포인트 | 메서드 | 설명 | 인증 |
|------------|--------|------|----------|
| `/api/payments/receipts/` | `GET` | 사용자의 모든 영수증 목록을 조회합니다. ||
| `/api/payments/receipts/{payment_id}/` | `GET` | 특정 결제에 대한 상세 영수증 정보를 조회합니다. ||
Expand Down

0 comments on commit 7b48e01

Please sign in to comment.