最終更新日時
Feb 20, 2024 2:56 AM
ツール
ChatGPT
利用シーン
設計/API設計
プロンプトテンプレート
機能要件をもとに、API一覧を整理します。
step by stepで考え、その結果のみ表形式で出力してください。
## 形式
API名、説明、REST種別、エンドポイント、API-ID、利用するTBL、必要工数
## 詳細な機能要件の記述
[ここに入力]
プロンプト例
機能要件をもとに、API一覧を整理します。
step by stepで考え、その結果のみ表形式で出力してください。
API名、説明、REST種別、エンドポイント、API-ID、利用するTBL、必要工数
## 詳細な機能要件の記述
1. **教育コンテンツのブラウジング**
- カテゴリやトピックに基づく検索機能。
- コンテンツのプレビュー表示。
- ユーザーレビューと評価の表示。
- 複数のフォーマット(テキスト、ビデオ、オーディオ)への対応。
2. **オンラインテスト**
- 複数の問題形式(選択式、記述式、マッチングなど)のサポート。 - テストの自動採点機能。
- テスト結果の即時フィードバック提供。
- テストの時間制限とプログレスバー表示。
25 |
3. **成績管理**
- 学生の成績データの入力と追跡。
- 成績レポートの自動生成。
- 教員による成績の手動調整とコメント追加。 - 学生への成績の通知とアクセス許可。
4. **ユーザー管理**
- ユーザーアカウントの作成、編集、削除。
- ユーザー権限の管理(学生、教員、管理者)。 - ユーザーアクティビティとログイン履歴の追跡。 - パスワードリセットとセキュリティ設定。
5. **コンテンツのアップロードと編集**
- ドラッグ&ドロップによるコンテンツアップロード機能。 - リッチテキストエディタを使用したコンテンツの編集。 - コンテンツのバージョン管理と変更履歴。
- 公開前のプレビューと承認プロセス。
6. **管理画面**
- 総合的なダッシュボード表示。
- ユーザー、コンテンツ、テストの管理。 - データ分析とレポート機能。
- システムの設定とカスタマイズ。
これらの機能要件は、STU 株式会社の目指す「教育コンテンツの提供と管理を行う多機能 Web サ ービス及び対応するモバイルアプリ(iOS・Android)の開発、さらにはこれらを管理するための管 理画面の構築」を実現するための基盤となります。
------
アウトプット例
機能要件に基づき、必要なAPIの一覧を以下の表にまとめます。
API名 説明 REST種別 エンドポイント API-ID 利用するTBL 必要工数 ContentSearch 教育コンテンツの検索 GET /contents/search CS001 Contents, Categories, Reviews 3 ContentPreview コンテンツのプレビュー表示 GET /contents/preview CP002 Contents 2 ContentReview ユーザーレビューと評価の表示 GET /contents/reviews CR003 Reviews 2 TestManagement テストの作成、採点、フィードバック提供 POST /tests/manage TM004 Tests, Questions, Responses 5 GradeManagement 成績の管理とレポート生成 POST /grades/manage GM005 Grades 4 UserManagement ユーザー管理(作成、編集、削除) POST /users/manage UM006 Users 4 UserAuthorization ユーザー権限とセキュリティ管理 POST /users/auth UA007 Users, AuthLogs 3 ContentUpload コンテンツのアップロード POST /contents/upload CU008 Contents 3 ContentEdit コンテンツの編集 PUT /contents/edit CE009 Contents 4 DashboardView 管理画面のダッシュボード表示 GET /admin/dashboard DV010 Users, Contents, Tests 3 SystemConfiguration システム設定とカスタマイズ POST /system/configure SC011 SystemSettings 3各APIは、指定された機能要件を満たすように設計されており、関連するテーブルや必要な工数を考慮しています。