postman_collection.json

{
  "info": {
    "name": "Chat Application API",
    "description": "Complete API collection for testing the Chat Application.\n\nEndpoints: Health, Users, Groups (with role-based auth), Messages (text/image/file), File Upload, and Combined File Message upload.\n\nBase URL variable: {{base_url}} defaults to http://localhost:8080",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "item": [
    {
      "name": "Health Check",
      "request": {
        "method": "GET",
        "header": [],
        "url": {
          "raw": "{{base_url}}/health",
          "host": ["{{base_url}}"],
          "path": ["health"]
        }
      }
    },
    {
      "name": "Users",
      "item": [
        {
          "name": "Create User",
          "request": {
            "method": "POST",
            "header": [{"key": "Content-Type", "value": "application/json"}],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"username\": \"john_doe\",\n  \"email\": \"john@example.com\"\n}"
            },
            "url": {
              "raw": "{{base_url}}/users",
              "host": ["{{base_url}}"],
              "path": ["users"]
            }
          }
        },
        {
          "name": "Get All Users",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/users",
              "host": ["{{base_url}}"],
              "path": ["users"]
            }
          }
        },
        {
          "name": "Get User by ID",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/users/1",
              "host": ["{{base_url}}"],
              "path": ["users", "1"]
            }
          }
        }
      ]
    },
    {
      "name": "Groups",
      "description": "Group management with role-based authorization. All mutating endpoints require `requester_id` to identify who is performing the action.\n\nRoles: owner, admin, member.\n- Only owners can delete groups, update group names, assign owner/admin roles.\n- Owners and admins can add/remove members and update member roles.\n- Nobody can remove or change the owner's role.\n- Owners cannot leave without transferring ownership first.",
      "item": [
        {
          "name": "List All Groups",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/groups",
              "host": ["{{base_url}}"],
              "path": ["groups"]
            }
          }
        },
        {
          "name": "Get Group by ID",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/groups/1",
              "host": ["{{base_url}}"],
              "path": ["groups", "1"]
            }
          }
        },
        {
          "name": "Create Group",
          "request": {
            "method": "POST",
            "header": [{"key": "Content-Type", "value": "application/json"}],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Project Team\"\n}"
            },
            "url": {
              "raw": "{{base_url}}/groups",
              "host": ["{{base_url}}"],
              "path": ["groups"]
            }
          }
        },
        {
          "name": "Update Group Name",
          "request": {
            "method": "PUT",
            "header": [{"key": "Content-Type", "value": "application/json"}],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Renamed Team\",\n  \"requester_id\": 1\n}"
            },
            "url": {
              "raw": "{{base_url}}/groups/1",
              "host": ["{{base_url}}"],
              "path": ["groups", "1"]
            },
            "description": "Update the group name. Only the group owner can perform this action."
          }
        },
        {
          "name": "Delete Group",
          "request": {
            "method": "DELETE",
            "header": [{"key": "Content-Type", "value": "application/json"}],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"requester_id\": 1\n}"
            },
            "url": {
              "raw": "{{base_url}}/groups/1",
              "host": ["{{base_url}}"],
              "path": ["groups", "1"]
            }
          }
        },
        {
          "name": "Add Member to Group",
          "request": {
            "method": "POST",
            "header": [{"key": "Content-Type", "value": "application/json"}],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"requester_id\": 1,\n  \"user_id\": 2,\n  \"role\": \"member\"\n}"
            },
            "url": {
              "raw": "{{base_url}}/groups/1/members",
              "host": ["{{base_url}}"],
              "path": ["groups", "1", "members"]
            }
          }
        },
        {
          "name": "Update Member Role",
          "request": {
            "method": "PATCH",
            "header": [{"key": "Content-Type", "value": "application/json"}],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"role\": \"admin\",\n  \"requester_id\": 1\n}"
            },
            "url": {
              "raw": "{{base_url}}/groups/1/members/2",
              "host": ["{{base_url}}"],
              "path": ["groups", "1", "members", "2"]
            },
            "description": "Update a member's role. Owners and admins can perform this action. Cannot change the owner's role. Only the owner can assign the owner role."
          }
        },
        {
          "name": "Remove Member from Group",
          "request": {
            "method": "DELETE",
            "header": [{"key": "Content-Type", "value": "application/json"}],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"requester_id\": 1\n}"
            },
            "url": {
              "raw": "{{base_url}}/groups/1/members/2",
              "host": ["{{base_url}}"],
              "path": ["groups", "1", "members", "2"]
            }
          }
        },
        {
          "name": "Get Group Members",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/groups/1/members",
              "host": ["{{base_url}}"],
              "path": ["groups", "1", "members"]
            }
          }
        },
        {
          "name": "Leave Group",
          "request": {
            "method": "POST",
            "header": [{"key": "Content-Type", "value": "application/json"}],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"user_id\": 2\n}"
            },
            "url": {
              "raw": "{{base_url}}/groups/1/leave",
              "host": ["{{base_url}}"],
              "path": ["groups", "1", "leave"]
            },
            "description": "Leave a group. The group owner cannot leave — they must transfer ownership first or delete the group."
          }
        }
      ]
    },
    {
      "name": "Messages",
      "item": [
        {
          "name": "Send Direct Message",
          "request": {
            "method": "POST",
            "header": [{"key": "Content-Type", "value": "application/json"}],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"sender_id\": 1,\n  \"receiver_id\": 2,\n  \"type\": \"text\",\n  \"content\": \"Hello, how are you?\"\n}"
            },
            "url": {
              "raw": "{{base_url}}/messages",
              "host": ["{{base_url}}"],
              "path": ["messages"]
            }
          }
        },
        {
          "name": "Send Group Message",
          "request": {
            "method": "POST",
            "header": [{"key": "Content-Type", "value": "application/json"}],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"sender_id\": 1,\n  \"group_id\": 1,\n  \"type\": \"text\",\n  \"content\": \"Hello team!\"\n}"
            },
            "url": {
              "raw": "{{base_url}}/messages",
              "host": ["{{base_url}}"],
              "path": ["messages"]
            }
          }
        },
        {
          "name": "Send Image Message (with file_id)",
          "request": {
            "method": "POST",
            "header": [{"key": "Content-Type", "value": "application/json"}],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"sender_id\": 1,\n  \"receiver_id\": 2,\n  \"type\": \"image\",\n  \"content\": \"Check out this image\",\n  \"file_id\": 1\n}"
            },
            "url": {
              "raw": "{{base_url}}/messages",
              "host": ["{{base_url}}"],
              "path": ["messages"]
            }
          }
        },
        {
          "name": "Send File Message (with file_id)",
          "request": {
            "method": "POST",
            "header": [{"key": "Content-Type", "value": "application/json"}],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"sender_id\": 1,\n  \"receiver_id\": 2,\n  \"type\": \"file\",\n  \"content\": \"Important document attached\",\n  \"file_id\": 2\n}"
            },
            "url": {
              "raw": "{{base_url}}/messages",
              "host": ["{{base_url}}"],
              "path": ["messages"]
            }
          }
        },
        {
          "name": "Upload File + Send Message",
          "request": {
            "method": "POST",
            "header": [],
            "body": {
              "mode": "formdata",
              "formdata": [
                {"key": "file", "type": "file", "src": "/path/to/file.png"},
                {"key": "sender_id", "value": "1"},
                {"key": "receiver_id", "value": "2"},
                {"key": "content", "value": "Check out this file!"}
              ]
            },
            "url": {
              "raw": "{{base_url}}/messages/upload",
              "host": ["{{base_url}}"],
              "path": ["messages", "upload"]
            },
            "description": "Upload a file and send it as a chat message in one request (multipart form data).\n\nFields:\n- file: The file to upload (required)\n- sender_id: ID of the sender (required, numeric)\n- receiver_id: ID of the receiver for direct messages\n- group_id: ID of the group for group messages\n- content: Optional text message\n\nAuto-detects message type: image/* Content-Type becomes type \"image\", everything else becomes type \"file\"."
          }
        },
        {
          "name": "Get Conversations List",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/conversations?user_id=1",
              "host": ["{{base_url}}"],
              "path": ["conversations"],
              "query": [
                {"key": "user_id", "value": "1"}
              ]
            },
            "description": "List all conversations for a user, with the latest message and unseen count per conversation.\n\nResponse:\n[\n  {\n    \"user_id\": 2,\n    \"username\": \"bob\",\n    \"last_message\": { \"id\": 10, \"content\": \"Hey!\", \"type\": \"text\", ... },\n    \"unseen_count\": 3\n  }\n]"
          }
        },
        {
          "name": "Edit Message",
          "request": {
            "method": "PUT",
            "header": [{"key": "Content-Type", "value": "application/json"}],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"sender_id\": 1,\n  \"content\": \"Updated message content\"\n}"
            },
            "url": {
              "raw": "{{base_url}}/messages/1",
              "host": ["{{base_url}}"],
              "path": ["messages", "1"]
            },
            "description": "Edit a message. You can only edit your own messages. Returns 400 if the message is not found, content is empty, or you don't own the message."
          }
        },
        {
          "name": "Get Conversation (Direct)",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/messages?receiver_id=2&limit=50&offset=0",
              "host": ["{{base_url}}"],
              "path": ["messages"],
              "query": [
                {"key": "receiver_id", "value": "2"},
                {"key": "limit", "value": "50"},
                {"key": "offset", "value": "0"}
              ]
            }
          }
        },
        {
          "name": "Get Conversation (Group)",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/messages?group_id=1&limit=50&offset=0",
              "host": ["{{base_url}}"],
              "path": ["messages"],
              "query": [
                {"key": "group_id", "value": "1"},
                {"key": "limit", "value": "50"},
                {"key": "offset", "value": "0"}
              ]
            }
          }
        },
        {
          "name": "Mark Message as Seen",
          "request": {
            "method": "POST",
            "header": [{"key": "Content-Type", "value": "application/json"}],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"user_id\": 1\n}"
            },
            "url": {
              "raw": "{{base_url}}/messages/1/seen",
              "host": ["{{base_url}}"],
              "path": ["messages", "1", "seen"]
            }
          }
        },
        {
          "name": "Delete Message",
          "request": {
            "method": "DELETE",
            "header": [],
            "url": {
              "raw": "{{base_url}}/messages/1",
              "host": ["{{base_url}}"],
              "path": ["messages", "1"]
            }
          }
        },
        {
          "name": "Get Unseen Messages Count",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/messages/unseen/1",
              "host": ["{{base_url}}"],
              "path": ["messages", "unseen", "1"]
            },
            "description": "Get count of unseen direct and group messages for a user, grouped by sender and group.\n\nResponse format:\n{\n  \"direct_messages\": [\n    { \"user_id\": 1, \"username\": \"john_doe\", \"unseen_count\": 5 },\n    { \"user_id\": 2, \"username\": \"jane_doe\", \"unseen_count\": 3 }\n  ],\n  \"group_messages\": [\n    { \"group_id\": 1, \"group_name\": \"Project Team\", \"unseen_count\": 4 },\n    { \"group_id\": 2, \"group_name\": \"General Chat\", \"unseen_count\": 2 }\n  ],\n  \"total\": 14\n}"
          }
        }
      ]
    },
    {
      "name": "File Upload",
      "item": [
        {
          "name": "Upload File",
          "request": {
            "method": "POST",
            "header": [],
            "body": {
              "mode": "formdata",
              "formdata": [
                {"key": "file", "type": "file", "src": "/path/to/file.png"}
              ]
            },
            "url": {
              "raw": "{{base_url}}/upload",
              "host": ["{{base_url}}"],
              "path": ["upload"]
            },
            "description": "Upload a file and get its metadata. The returned `id` can be used as `file_id` when sending a message.\n\nResponse:\n{\n  \"id\": 1,\n  \"url\": \"/uploads/abc123.png\",\n  \"size\": 1024,\n  \"type\": \"image/png\",\n  \"created_at\": \"...\",\n  \"updated_at\": \"...\"\n}"
          }
        }
      ]
    }
  ],
  "variable": [
    {
      "key": "base_url",
      "value": "http://localhost:8080",
      "type": "string"
    }
  ]
}