ModParks Wiki

この文書は読取専用です。文書のソースを閲覧することは可能ですが、変更はできません。もし変更したい場合は管理者に連絡してください。
====== Auth & Users API ======

このAPIでは、ユーザーのログイン認証やプロフィールの管理、他のユーザー情報の取得、およびフォロー機能を提供します。

===== メソッド一覧 =====

  * [[#ログイン]]
  * [[#自身のプロフィール取得]]
  * [[#プロフィールの更新]]
  * [[#ユーザー情報の取得]]
  * [[#ユーザーのフォロー]]
  * [[#フォローの解除]]

----

===== ログイン =====

ユーザーを認証し、APIリクエストに必要なセッショントークンを発行します。

==== HTTP リクエスト ====

''POST https://modparks.pitan76.net/api/v1/auth/login''

==== リクエストボディ ====

リクエストには、以下の項目を含めたJSONデータを送信してください。

^ プロパティ ^ タイプ ^ 備考 ^
| ''username'' | string | ユーザー名。 |
| ''password'' | string | ユーザーのパスワード。 |

==== レスポンス ====

認証に成功すると、トークンを含む以下のJSONが返却されます。

<code json>
{
  "success": true,
  "token": "string"
}
</code>

----

===== 自身のプロフィール取得 =====

現在ログインしているユーザーの基本情報を取得します。

==== HTTP リクエスト ====

''GET https://modparks.pitan76.net/api/v1/auth/me''

==== 認証 ====

このエンドポイントを利用するには、有効なAPIトークンまたはセッションによる認証が必要です。

==== レスポンス ====

リクエストが成功すると、ユーザー情報を表すJSONオブジェクトが返却されます。

<code json>
{
  "id": "string",
  "username": "string",
  "displayName": "string",
  "avatarUrl": "string"
}
</code>

----

===== プロフィールの更新 =====

現在ログインしているユーザーの公開プロフィール情報を変更します。

==== HTTP リクエスト ====

''PUT https://modparks.pitan76.net/api/v1/profile''

==== 認証 ====

このエンドポイントを利用するには、有効なAPIトークンまたはセッションによる認証が必要です。

==== リクエストボディ ====

変更したい項目のみを含むJSONデータを送信してください。

^ プロパティ ^ タイプ ^ 備考 ^
| ''displayName'' | string | サイト上に表示されるユーザー名。 |
| ''bio'' | string | 自己紹介文。 |
| ''avatarUrl'' | string | アバター画像のURL。 |

==== レスポンス ====

更新が完了すると、HTTPステータス ''200 OK'' が返却されます。

----

===== ユーザー情報の取得 =====

指定したユーザーの公開プロフィールと、その人が公開しているプロジェクト（MOD、プラグイン等）の一覧を取得します。

==== HTTP リクエスト ====

''GET https://modparks.pitan76.net/api/v1/users/{username}''

==== パスパラメータ ====

^ パラメータ ^ タイプ ^ 備考 ^
| ''username'' | string | 情報を取得したい対象ユーザーのユーザー名。 |

==== レスポンス ====

リクエストが成功すると、以下のJSONが返却されます。

<code json>
{
  "user": {
    "username": "string",
    "displayName": "string",
    "bio": "string",
    "avatarUrl": "string"
  },
  "projects": [
    // プロジェクト情報の配列
  ]
}
</code>

----

===== ユーザーのフォロー =====

指定したユーザーをフォローします。

==== HTTP リクエスト ====

''POST https://modparks.pitan76.net/api/v1/users/{username}/follow''

==== パスパラメータ ====

^ パラメータ ^ タイプ ^ 備考 ^
| ''username'' | string | フォローしたい対象ユーザーのユーザー名。 |

==== 認証 ====

このエンドポイントを利用するには、有効なAPIトークンまたはセッションによる認証が必要です。

==== レスポンス ====

フォロー処理が成功すると、HTTPステータス ''200 OK'' が返却されます。

----

===== フォローの解除 =====

指定したユーザーのフォローを解除します。

==== HTTP リクエスト ====

''DELETE https://modparks.pitan76.net/api/v1/users/{username}/follow''

==== パスパラメータ ====

^ パラメータ ^ タイプ ^ 備考 ^
| ''username'' | string | フォローを解除したい対象ユーザーのユーザー名。 |

==== 認証 ====

このエンドポイントを利用するには、有効なAPIトークンまたはセッションによる認証が必要です。

==== レスポンス ====

フォロー解除が完了すると、HTTPステータス ''200 OK'' が返却されます。