diff --git a/src-manager/README.md b/src-manager/README.md index a8ec79a..d83b52f 100644 --- a/src-manager/README.md +++ b/src-manager/README.md @@ -7,6 +7,7 @@ SERA Websiteのニュース等のコンテンツを管理する * JavaScript * express * htmx +* axios * node npm * sqlite @@ -16,7 +17,7 @@ SERA Websiteのニュース等のコンテンツを管理する cd src-manager/ # このディレクトリーに移動 npm install # 依存パッケージのインストール、まだ一度も実行していない場合 npm start # サーバーを起動、ブラウザで http://localhost:3001 に入る -npm run dev # ファイル変更時に自動リロードが入る開発サーバーを起動する。同じく http://localhost:3001 でホストされる +npm run dev # JSファイル変更時に自動リロードが入る開発サーバーを起動する。同じく http://localhost:3001 でホストされる ``` ## データベース @@ -26,9 +27,17 @@ npm run dev # ファイル変更時に自動リロードが入る開発サーバ * id - PRIMARY KEY - 整数 * date - Unix時間 - 整数 * entryType - 記事(0) か ツイート風(1) - 整数 -* cardcontent - ニュースリストで表示されるコンテンツ、Markdown可 - 文字列(Markdown) +* cardContent - ニュースリストで表示されるコンテンツ、Markdown可 - 文字列(Markdown) * article - Markdownで書かれた記事 - 文字列(Markdown) * linkPath - ニュースリストで表示されるリンク先 - 文字列 * coverImagePath - ニュースリストで表示される画像へのパス - 文字列 -## API \ No newline at end of file +## API(RESTful) + +* `/api/news` + * GET: Unix時間で特定されたニュースの情報を取得する - `?target=` + * POST: 新しいニュースを作成する + * PUT: ニュースの内容を更新する + * DELETE: Unix時間で特定されたニュースを削除する - `?target=` +* `/api/news-list` + * GET: 全ニュースの情報を取得する