リソース設計を行う

[Kassy0220]

5 に基づき、このIssueではリソース設計を行います。

• エレベーターピッチ
• ペーパープロトタイプ

アプリ内でアクセスできるページと、React内からデータを取得・更新するためのAPIを分けています。

アクセス可能なリソース

HTTPメソッド	パス	説明
GET	/	アプリのトップページ(ログイン後はマイページが表示される)
POST	/auth/github	GitHub OAth Appに認可リクエストを送る
GET	/auth/:provider/callback	GitHub OAth Appから受け取った情報を元にログインする
DELETE	/logout	ログアウトする
GET	/minutes	議事録一覧
GET	/minutes/:id	議事録詳細
GET	/minutes/:id/edit	議事録編集
POST	/minutes/:minute_id/exports	議事録をGitHub Wikiにエクスポートする
GET	/minutes/:minute_id/attendances/new	議事録に紐づく出席を新規作成
POST	/minutes/:minute_id/attendances	議事録に紐づく出席作成
GET	/attendances/:id/edit	出席編集
PTACH	/attendances/:id	出席更新
GET	/members	メンバー一覧
GET	/members/:id	チームメンバー詳細
GET	/terms_of_service	利用規約を表示
GET	/privacy_policy	プライバシーポリシーを表示

備考

• ログインは、Devise + omniauthを使ってログインを行います
• 議事録の作成は、Rakeタスク + Heroku Scheduler で行います
• 議事録の更新は、議事録の各項目ごとにReactでフォームを作成しfetch APIを利用して行います

API

HTTPメソッド	パス	説明
GET	/api/minutes/:id	議事録詳細
PATCH	/api/minutes/:id	議事録更新
GET	/api/minutes/:minute_id/attendances	議事録に紐づく出席一覧
GET	/api/minutes/:minute_id/topics	議事録に紐づく「話題にしたいこと・心配事」一覧
POST	/api/minutes/:minute_id/topics	議事録に紐づく「話題にしたいこと・心配事」作成
PATCH	/api/minutes/:minute_id/topics	議事録に紐づく「話題にしたいこと・心配事」更新
GET	/api/members/:member_id/attendances	メンバーに紐づく出席一覧
POST	/api/members/:member_id/hiatuses	メンバーに紐づく休止作成
GET	/api/minutes	議事録一覧
GET	/api/members	メンバー一覧

備考

• 「 議事録詳細 」から「議事録に紐づく「話題にしたいこと・心配事」更新」までのAPIは、議事録編集ページ内の各項目を表示するReactコンポーネントからアクセスします
• 「メンバーに紐づく出席一覧」APIは、メンバー一覧やメンバー詳細でメンバーの出席状況を表示するReactコンポーネントからアクセスします
• 「メンバーに紐づく休止作成」APIは、メンバー一覧ページの退会させるボタン(Reactコンポーネント)からアクセスします
• 「議事録一覧」APIは、議事録一覧ページで議事録一覧を表示するReactコンポーネントからアクセスします
• 「メンバー一覧」APIは、メンバー一覧ページでメンバー一覧を表示するReactコンポーネントからアクセスします