README_ja.md

 

NISROOM API for Lambda

編集者

---

概要

AWS Lambda を用いた NISLAB ルームモニター API です

フロントエンド

アーキテクチャ

API 仕様書

API リスト

No.	API 機能 No.	型	API 名	概要
0	NISROOM-000	API	nisroom-api	製品版環境
1	NISROOM-001	API	nisroom-api-dev	テスト環境

リソース 型名

students

---

HTTP メソッド	アクセス URI	目的
GET	/v1/students	メンバーに関する全情報を取得

• GET Data (JSON)

カテゴリー	JSON キー	型	概要
None

• Response Data (JSON)

カテゴリー	JSON キー	型	概要
ID	id	Value	ID
Image	avatar	URL	Slack のアイコン
First Name (En)	e_first_name	String	名前（英語）
Last Name (En)	e_last_name	String	苗字（英語）
Grade	grade	String	メンバーの学年
Status of stay	is_stay	Boolean	メンバーの研究室在室情報
First Name (Ja)	j_first_name	String	名前
Last Name (Ja)	j_last_name	String	苗字
Student ID	student_id	Value	学生 ID
Scheduled date of visit	schedule	Array	来室スケジュール

id

---

HTTP メソッド	アクセス URI	目的
PATCH	/v1/students/{id}	メンバーに関する情報の更新

• PATCH Data (JSON)

カテゴリー	JSON キー	型	概要
Status of stay	is_stay	Boolean	メンバーの研究室在室情報
Scheduled date of visit	schedule	Array	来室予定日({YYYY-MM-DD, YYYY-MM-D'D', ...}) もし値が空の配列だった場合 null を返します。

• Response Data (JSON)

カテゴリー	JSON キー	型	概要
Status of stay	is_stay	Boolean	メンバーの研究室在室情報
Scheduled date of visit	schedule	Array	来室予定日 (["YYYY-MM-DD", "YYYY-MM-D'D', ...])

データベースデザインと構造

students テーブル

プライマリキー	属性
パーティションキー
id	avater	e_first_name	e_last_name	grade	is_stay	j_first_name	j_last_name	student_id	schedule
{Integer}	{String}	{String}	{String}	{Integer}	{Boolean}	{String}	{String}	{Integer}	{StringSet}

ステータスコード

ステータスコード	概要
200 OK	HTTP リクエストが成功した場合の標準的なレスポンスです。実際のレスポンスは、使用したリクエストメソッドによって異なります。
403 Forbidden	リクエストは合法的なものでしたが、サーバーがその応答を拒否しています。401 Unauthorized レスポンスとは異なり、認証しても違いはありません。
502 Bad Gateway	サーバーがゲートウェイまたはプロキシとして動作しており、上流のサーバーから無効な応答を受信しました。

---

開発者向け

リポジトリの使い方

1. フォークとクローン
2. git remote add upstream https://github.com/Kenny-NISLab/nisroom-api.git
3. git pull upstream develop

セットアップ

1. npm install

コミットする前のフォーマット

1. npm run format