From f30f0a634e71ad72e35062fc7e447f244ebe66ff Mon Sep 17 00:00:00 2001 From: ItAdmin Date: Wed, 22 Apr 2026 05:02:31 +0000 Subject: [PATCH] =?UTF-8?q?"/"=20=E3=81=AB=E3=83=95=E3=82=A1=E3=82=A4?= =?UTF-8?q?=E3=83=AB=E3=82=92=E3=82=A2=E3=83=83=E3=83=97=E3=83=AD=E3=83=BC?= =?UTF-8?q?=E3=83=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- index05.md | 238 +++++++++++++++++++++++++++++++++ index06.md | 97 ++++++++++++++ index07.md | 380 +++++++++++++++++++++++++++++++++++++++++++++++++++++ index08.md | 50 +++++++ 4 files changed, 765 insertions(+) create mode 100644 index05.md create mode 100644 index06.md create mode 100644 index07.md create mode 100644 index08.md diff --git a/index05.md b/index05.md new file mode 100644 index 0000000..15092d8 --- /dev/null +++ b/index05.md @@ -0,0 +1,238 @@ +# /external + +外部からのアクセス時の処理に関するAPIです。 + +## /authenticateuser + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日: 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /item/{key} + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日: 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /list + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日: 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /register + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日: 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /update + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日: 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
diff --git a/index06.md b/index06.md new file mode 100644 index 0000000..f245007 --- /dev/null +++ b/index06.md @@ -0,0 +1,97 @@ +# /jslib + +JavaScriptライブラリに関するAPIです。 + +## /{filename} + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日: 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /list + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日: 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
diff --git a/index07.md b/index07.md new file mode 100644 index 0000000..0eea61f --- /dev/null +++ b/index07.md @@ -0,0 +1,380 @@ +# /json + +JSON形式のデータやファイルに関するAPIです。 + +## /data/{id} + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | ? Fetch resource | データの取得 | +| `POST` | ? Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日: 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /file/{id} + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日: 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /list + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日: 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /meta/{id} + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日: 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /ownerlist + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日: 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /remove/{id} + +remove meta and file + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日: 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /update/{id} + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日: 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /update/meta/{id} + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日: 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
diff --git a/index08.md b/index08.md new file mode 100644 index 0000000..d90500c --- /dev/null +++ b/index08.md @@ -0,0 +1,50 @@ +# /masterdata + +マスターデータに関するAPIです。 + +## /data/query + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日: 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +