aboutsummaryrefslogtreecommitdiffstats
path: root/translations/README.ja.md
diff options
context:
space:
mode:
Diffstat (limited to 'translations/README.ja.md')
-rw-r--r--translations/README.ja.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/translations/README.ja.md b/translations/README.ja.md
new file mode 100644
index 0000000..6e81103
--- /dev/null
+++ b/translations/README.ja.md
@@ -0,0 +1,26 @@
+# 銀行 API
+
+銀行 API は [Node.js](https://nodejs.org/ja/) plus [Express](https://expressjs.com/ja/) で構築されています。
+
+## サーバーの実行
+
+[Node.js](https://nodejs.org/ja/) がインストールされていることを確認してください。
+
+1. このリポジトリを Git でクローンします
+2. `npm install` を実行します
+3. `npm start` を実行します
+
+サーバーは `5000` ポートで待ち受けを開始するはずです。
+
+> 注意: すべてのエントリはメモリに保存され、永続化されないので、サーバを停止するとすべてのデータが失われます。
+
+## API の詳細
+
+ルート | 説明
+----------------------------------------------|------------------------------------
+GET /api/ | サーバー情報を取得します
+POST /api/accounts/ | アカウントを作成します。例: `{ user: 'Yohan', description: 'My budget', currency: 'EUR', balance: 100 }`
+GET /api/accounts/:user | 指定したアカウントのすべてのデータを取得します
+DELETE /api/accounts/:user | 指定したアカウントを削除します
+POST /api/accounts/:user/transactions | トランザクションを追加します。例: `{ date: '2020-07-23T18:25:43.511Z', object: 'Bought a book', amount: -20 }`
+DELETE /api/accounts/:user/transactions/:id | 指定されたトランザクションを削除します