api.md

API設計

動作確認用のエンドポイント

GET /api/hello

リクエストボディ

-

レスポンス

{
    "message": "hello, world!"
}

動作確認用のエンドポイント(認証必須)

GET /api/user

リクエストヘッダ

Authorization: Bearer XXXXXXXXXX

リクエストボディ

-

レスポンス

{
    "id": 1,
    "user_id": "test",
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
}

サインアップ

POST /api/auth/signup

リクエストボディ

{
    "user_id": "test",
    "password": "password"
}

レスポンス

{
    "token": "XXXXXXXXXX"
}

サインイン

POST /api/auth/signin

リクエストボディ

{
    "user_id": "test",
    "password": "password"
}

レスポンス

{
    "token": "XXXXXXXXXX"
}

寄せ書きの作成

POST /api/envelopes

リクエストヘッダ

Authorization: Bearer XXXXXXXXXX

リクエストボディ

{
    "title": "test"
}

レスポンス

{
    "id": 1,
    "code": "82d76e1c-1df2-4e0d-a4a2-a89ce6d70791",
    "title": "ccc",
    "sender_id": 1,
    "holder_id": 1,
    "state": "IN_PROGRESS",
    "created_at": "2024-08-24T17:27:32.000000Z",
    "updated_at": "2024-08-24T17:27:32.000000Z"
}

寄せ書きの存在確認

POST /api/envelopes/verify

リクエストヘッダ

Authorization: Bearer XXXXXXXXXX

リクエストボディ

-

レスポンス

{
    "exist_envelope": true,
    "envelope_id": 1
}

寄せ書きの受け取り

PUT /api/envelopes

リクエストヘッダ

Authorization: Bearer XXXXXXXXXX

リクエストボディ

{
    "code": "0d518795-a026-4a89-8bf2-d2e16c1b6cd0"
}

レスポンス

{
    "id": 1,
    "code": "0d518795-a026-4a89-8bf2-d2e16c1b6cd0",
    "title": "test",
    "sender_id": 1,
    "holder_id": 1,
    "state": "RECEIVED",
    "created_at": "2024-08-24T17:26:13.000000Z",
    "updated_at": "2024-08-24T18:08:12.000000Z",
    "messages": [
        {
            "id": 1,
            "envelope_id": 1,
            "content": "がんばれ",
            "writer_id": 1,
            "writer_name": "ヒデアキ",
            "created_at": null,
            "updated_at": null
        }
        ...
    ]
}

メッセージの作成

POST /api/messages

リクエストヘッダ

Authorization: Bearer XXXXXXXXXX

リクエストボディ

{
    "envelope_id": 1,
    "content": "がんばれ",
    "writer_name": "ヒデアキ"
}

レスポンス

{
    "id": 1,
    "envelope_id": 1,
    "content": "がんばれ",
    "writer_id": 1,
    "writer_name": "ヒデアキ",
    "created_at": "2024-08-24T18:27:42.000000Z",
    "updated_at": "2024-08-24T18:27:42.000000Z",
}