今後の API 一覧
文書目的
この文書は、現在の demo を実プロジェクトへ移行する際に必要となるバックエンド API を業務ドメイン別に整理するものです。
ここでは最終プロトコルではなく、必要なインターフェース項目を列挙します。
1. ユーザーと認証
インターフェース項目:
POST /auth/loginPOST /auth/logoutGET /auth/meGET /students/profileGET /students/growth-summary
2. コースカタログと受講中コース
インターフェース項目:
GET /courses/catalogGET /courses/catalog/:courseIdGET /students/coursesGET /students/courses/:courseId
3. 時間割と lesson
インターフェース項目:
GET /schedule/weekGET /schedule/dayGET /courses/:courseId/lessonsGET /courses/:courseId/lessons/:lessonId
4. assessment と成長記録
インターフェース項目:
GET /courses/:courseId/assessmentsGET /courses/:courseId/assessments/:assessmentIdGET /students/growth/radarGET /students/growth/trendGET /students/growth/milestones
5. タスクと宿題
インターフェース項目:
GET /tasks/dailyPOST /tasks/daily/vocab/:wordId/completePOST /tasks/daily/check-inGET /homeworks/currentPOST /homeworks/:homeworkId/submissionsGET /homeworks/:homeworkId/feedback
6. メッセージセンター
インターフェース項目:
GET /notificationsGET /notifications/:notificationIdPOST /notifications/:notificationId/readPOST /notifications/read-all
7. イベント
インターフェース項目:
GET /activitiesGET /activities/:activityIdPOST /activities/:activityId/signupPOST /activities/:activityId/cancelGET /activities/:activityId/registration
8. 注文と支払い
インターフェース項目:
POST /ordersGET /orders/:orderIdPOST /orders/:orderId/payGET /payments/:paymentId/statusGET /students/orders
9. 会員体系
インターフェース項目:
GET /memberships/currentGET /memberships/plansPOST /memberships/ordersGET /memberships/orders/:orderId