Skip to content

auth.md

Latest commit

 

History

History
141 lines (104 loc) · 3.03 KB

auth.md

File metadata and controls

141 lines (104 loc) · 3.03 KB
Raw

認証

1. 概要

メソッド エンドポイント 説明 　フロント
POST /api/v1/auth/register 新規登録 /register
POST /api/v1/auth/login アクセストークン & リフレッシュトークン 発行 /login
POST /api/v1/auth/logout トークン無効化
GET /api/v1/auth/me 現在ログイン中のユーザー情報取得
POST /api/v1/auth/refresh アクセストークン再発行

2. 共通ヘッダーについて

ログイン状態にあるものにはヘッダーにアクセストークンを付与 これがあるときは /auth/logout, auth/me, /auth/refresh にアクセス可能

  • ヘッダー
{
  "Authorization": Bearer {アクセストークン}
}

3. エラー処理

3.1 必須フィールドなし

{
  "error": {
    "code": 400,
    "message": "",
    "errors": {}
  }
}

※その他ステータスコード別の message はエラーハンドリングを参照

4. リクエスト・レスポンス例

4.1 POST | /api/v1/auth/register

  • リクエストボディ

    {
  "user_name": "",
  "email": "",
  "password": ""
}

  • レスポンス

    • 成功時
    {
  "message": "新規登録しました。",
  "accessToken": ""
}

4.2 POST | /api/v1/auth/login

  • リクエストボディ
{
  "email": "",
  "password": ""
}

  • レスポンス

    • 成功時
    {
  "message": "ログインしました。",
  "accessToken": "",
  "is_staff": "",
  "admin": ""
}

4.3 POST | /api/v1/auth/logout

  • レスポンス

    • 成功時
    {
  "message": "ログアウトしました。"
}

4.4 GET | /api/v1/auth/me

  • レスポンス

    • 成功時
    {
  "user_name": "user_example",
  "email": "user@example.com",
  "is_staff": true
}

4.5 POST | /api/v1/auth/refresh

  • レスポンス

    • 成功時
    {
  "message": "アクセストークンを再発行しました。",
  "accessToken": ""
}