"/" にファイルをアップロード

This commit is contained in:
ItAdmin 2026-04-22 05:02:31 +00:00
parent 2299433158
commit f30f0a634e
4 changed files with 765 additions and 0 deletions

238
index05.md Normal file
View File

@ -0,0 +1,238 @@
# /external
外部からのアクセス時の処理に関するAPIです。
## /authenticateuser
?
| HTTP Method | Description | |
| ---------------- | -------------------------------------- | ---------------------------------- |
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
:arrow_forward: ^^リクエスト^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルリクエストデータ
``` JSON title="JSON"
TBD
```
:arrow_backward: ^^レスポンス^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルレスポンスデータ
``` JSON title="JSON"
{"id":"hogefuga","secret":"abrakadabra"}
```
!!! 補足
* 最終更新日: 2025/xx/xx
??? フリーメモ
* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます
<br>
## /item/{key}
?
| HTTP Method | Description | |
| ---------------- | -------------------------------------- | ---------------------------------- |
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
:arrow_forward: ^^リクエスト^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルリクエストデータ
``` JSON title="JSON"
TBD
```
:arrow_backward: ^^レスポンス^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルレスポンスデータ
``` JSON title="JSON"
{"id":"hogefuga","secret":"abrakadabra"}
```
!!! 補足
* 最終更新日: 2025/xx/xx
??? フリーメモ
* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます
<br>
## /list
?
| HTTP Method | Description | |
| ---------------- | -------------------------------------- | ---------------------------------- |
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
:arrow_forward: ^^リクエスト^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルリクエストデータ
``` JSON title="JSON"
TBD
```
:arrow_backward: ^^レスポンス^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルレスポンスデータ
``` JSON title="JSON"
{"id":"hogefuga","secret":"abrakadabra"}
```
!!! 補足
* 最終更新日: 2025/xx/xx
??? フリーメモ
* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます
<br>
## /register
?
| HTTP Method | Description | |
| ---------------- | -------------------------------------- | ---------------------------------- |
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
:arrow_forward: ^^リクエスト^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルリクエストデータ
``` JSON title="JSON"
TBD
```
:arrow_backward: ^^レスポンス^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルレスポンスデータ
``` JSON title="JSON"
{"id":"hogefuga","secret":"abrakadabra"}
```
!!! 補足
* 最終更新日: 2025/xx/xx
??? フリーメモ
* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます
<br>
## /update
?
| HTTP Method | Description | |
| ---------------- | -------------------------------------- | ---------------------------------- |
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
:arrow_forward: ^^リクエスト^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルリクエストデータ
``` JSON title="JSON"
TBD
```
:arrow_backward: ^^レスポンス^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルレスポンスデータ
``` JSON title="JSON"
{"id":"hogefuga","secret":"abrakadabra"}
```
!!! 補足
* 最終更新日: 2025/xx/xx
??? フリーメモ
* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます
<br>

97
index06.md Normal file
View File

@ -0,0 +1,97 @@
# /jslib
JavaScriptライブラリに関するAPIです。
## /{filename}
?
| HTTP Method | Description | |
| ---------------- | -------------------------------------- | ---------------------------------- |
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
:arrow_forward: ^^リクエスト^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルリクエストデータ
``` JSON title="JSON"
TBD
```
:arrow_backward: ^^レスポンス^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルレスポンスデータ
``` JSON title="JSON"
{"id":"hogefuga","secret":"abrakadabra"}
```
!!! 補足
* 最終更新日: 2025/xx/xx
??? フリーメモ
* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます
<br>
## /list
?
| HTTP Method | Description | |
| ---------------- | -------------------------------------- | ---------------------------------- |
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
:arrow_forward: ^^リクエスト^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルリクエストデータ
``` JSON title="JSON"
TBD
```
:arrow_backward: ^^レスポンス^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルレスポンスデータ
``` JSON title="JSON"
{"id":"hogefuga","secret":"abrakadabra"}
```
!!! 補足
* 最終更新日: 2025/xx/xx
??? フリーメモ
* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます
<br>

380
index07.md Normal file
View File

@ -0,0 +1,380 @@
# /json
JSON形式のデータやファイルに関するAPIです。
## /data/{id}
?
| HTTP Method | Description | |
| ---------------- | -------------------------------------- | ---------------------------------- |
| `GET` | <span style="color: gray; ">?</span> Fetch resource | データの取得 |
| `POST` | <span style="color: gray; ">?</span> Create resource | データの送信 (主に新規作成) |
:arrow_forward: ^^リクエスト^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルリクエストデータ
``` JSON title="JSON"
TBD
```
:arrow_backward: ^^レスポンス^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルレスポンスデータ
``` JSON title="JSON"
{"id":"hogefuga","secret":"abrakadabra"}
```
!!! 補足
* 最終更新日: 2025/xx/xx
??? フリーメモ
* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます
<br>
## /file/{id}
?
| HTTP Method | Description | |
| ---------------- | -------------------------------------- | ---------------------------------- |
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
:arrow_forward: ^^リクエスト^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルリクエストデータ
``` JSON title="JSON"
TBD
```
:arrow_backward: ^^レスポンス^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルレスポンスデータ
``` JSON title="JSON"
{"id":"hogefuga","secret":"abrakadabra"}
```
!!! 補足
* 最終更新日: 2025/xx/xx
??? フリーメモ
* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます
<br>
## /list
?
| HTTP Method | Description | |
| ---------------- | -------------------------------------- | ---------------------------------- |
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
:arrow_forward: ^^リクエスト^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルリクエストデータ
``` JSON title="JSON"
TBD
```
:arrow_backward: ^^レスポンス^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルレスポンスデータ
``` JSON title="JSON"
{"id":"hogefuga","secret":"abrakadabra"}
```
!!! 補足
* 最終更新日: 2025/xx/xx
??? フリーメモ
* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます
<br>
## /meta/{id}
?
| HTTP Method | Description | |
| ---------------- | -------------------------------------- | ---------------------------------- |
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
:arrow_forward: ^^リクエスト^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルリクエストデータ
``` JSON title="JSON"
TBD
```
:arrow_backward: ^^レスポンス^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルレスポンスデータ
``` JSON title="JSON"
{"id":"hogefuga","secret":"abrakadabra"}
```
!!! 補足
* 最終更新日: 2025/xx/xx
??? フリーメモ
* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます
<br>
## /ownerlist
?
| HTTP Method | Description | |
| ---------------- | -------------------------------------- | ---------------------------------- |
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
:arrow_forward: ^^リクエスト^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルリクエストデータ
``` JSON title="JSON"
TBD
```
:arrow_backward: ^^レスポンス^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルレスポンスデータ
``` JSON title="JSON"
{"id":"hogefuga","secret":"abrakadabra"}
```
!!! 補足
* 最終更新日: 2025/xx/xx
??? フリーメモ
* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます
<br>
## /remove/{id}
remove meta and file
| HTTP Method | Description | |
| ---------------- | -------------------------------------- | ---------------------------------- |
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
:arrow_forward: ^^リクエスト^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルリクエストデータ
``` JSON title="JSON"
TBD
```
:arrow_backward: ^^レスポンス^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルレスポンスデータ
``` JSON title="JSON"
{"id":"hogefuga","secret":"abrakadabra"}
```
!!! 補足
* 最終更新日: 2025/xx/xx
??? フリーメモ
* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます
<br>
## /update/{id}
?
| HTTP Method | Description | |
| ---------------- | -------------------------------------- | ---------------------------------- |
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
:arrow_forward: ^^リクエスト^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルリクエストデータ
``` JSON title="JSON"
TBD
```
:arrow_backward: ^^レスポンス^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルレスポンスデータ
``` JSON title="JSON"
{"id":"hogefuga","secret":"abrakadabra"}
```
!!! 補足
* 最終更新日: 2025/xx/xx
??? フリーメモ
* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます
<br>
## /update/meta/{id}
?
| HTTP Method | Description | |
| ---------------- | -------------------------------------- | ---------------------------------- |
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
:arrow_forward: ^^リクエスト^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルリクエストデータ
``` JSON title="JSON"
TBD
```
:arrow_backward: ^^レスポンス^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルレスポンスデータ
``` JSON title="JSON"
{"id":"hogefuga","secret":"abrakadabra"}
```
!!! 補足
* 最終更新日: 2025/xx/xx
??? フリーメモ
* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます
<br>

50
index08.md Normal file
View File

@ -0,0 +1,50 @@
# /masterdata
マスターデータに関するAPIです。
## /data/query
?
| HTTP Method | Description | |
| ---------------- | -------------------------------------- | ---------------------------------- |
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
:arrow_forward: ^^リクエスト^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルリクエストデータ
``` JSON title="JSON"
TBD
```
:arrow_backward: ^^レスポンス^^
パラメータ
| 名称 | 型 | 例 | 必須 | 説明 |
| ---- | --- | --- | --- | --- |
| _ | _ | _ | _ | 説明がここに記述されます。 |
サンプルレスポンスデータ
``` JSON title="JSON"
{"id":"hogefuga","secret":"abrakadabra"}
```
!!! 補足
* 最終更新日: 2025/xx/xx
??? フリーメモ
* エンジニアが共有などのメモを残していくことができるエリアです
* 自由なメモを記載できます
<br>