JSON Database API V2
APIエンドポイント: https://events-front.mixeder.net/v2/jsdbv2
概要
このAPIは、JSONデータベースに対するCRUD操作(読み込み、追加、更新、削除)を提供します。連番を自動的に管理し、簡単にデータを操作できます。
リクエスト形式
ベースURL:
https://events-front.mixeder.net/v2/jsdbv2メソッド:
GET/POST(アクションによる)
共通パラメータ
key
はい
JSONファイルを特定するためのキー
action
いいえ
実行するアクション(デフォルト: read)
id
条件付き
特定のデータを指定するID(更新/削除時に必要)
data
条件付き
JSON形式のデータ(追加/更新時に必要)
エンドポイントの詳細
1. データの取得 (Read)
概要: 指定されたJSONデータを取得します。
HTTPメソッド:
GETリクエスト例:
GET /v2/jsdbv2?key=mydata&action=read特定IDの取得:
GET /v2/jsdbv2?key=mydata&action=read&id=1レスポンス例(全データ取得時):
{ "1": { "name": "Item 1", "price": 100 }, "2": { "name": "Item 2", "price": 200 } }レスポンス例(特定ID取得時):
{ "name": "Item 1", "price": 100 }
2. データの追加 (Add)
概要: 新しいデータを追加し、自動連番のIDを付与します。
HTTPメソッド:
GETorPOSTリクエスト例:
POST /v2/jsdbv2?key=mydata&action=add&data={"name":"Item 3","price":300}レスポンス例:
{ "success": "Data added successfully.", "id": 3 }
3. データの更新 (Update)
概要: 特定のIDを指定してデータを更新します。
HTTPメソッド:
GETorPOSTリクエスト例:
POST /v2/jsdbv2?key=mydata&action=update&id=1&data={"name":"Updated Item","price":150}レスポンス例:
{ "success": "Data updated successfully." }
4. データの削除 (Delete)
概要: 特定のIDを指定してデータを削除します。
HTTPメソッド:
GETorPOSTリクエスト例:
POST /v2/jsdbv2?key=mydata&action=delete&id=1レスポンス例:
{ "success": "Data deleted successfully." }
エラーレスポンス
400
{"error": "Invalid action specified."}
不正なアクションが指定された場合
400
{"error": "Key parameter is missing."}
key パラメータが不足している場合
404
{"error": "Data not found."}
指定されたIDのデータが存在しない場合
400
{"error": "Invalid data format."}
提供されたデータ形式が不正な場合
注意事項
データは指定された
keyを基にJSONファイルとして保存されます。データが存在しない場合、APIは自動で空のJSONファイルを作成します。
データのインデックスは1から始まり、連番で自動管理されます。
これでAPIの仕様が明確に伝わるはずです!他に追加情報が必要であれば教えてください。
最終更新
役に立ちましたか?