Chat Service REST API (1.0)

Download OpenAPI specification:

Auth

Authenticate a user

Authenticate a user

Request Body schema: application/json
required
username
required
string\w{2,20}
password
required
string >= 5 characters

Responses

Request samples

Content type
application/json
{
  • "username": "john",
  • "password": "12345"
}

Users

Get all users

Get all users

Authorizations:
bearerAuth
query Parameters
status
string
Enum: "ONLINE" "OFFLINE"

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Register a user

Register a user

Request Body schema: application/json
required
username
required
string\w{2,20}
password
required
string >= 5 characters

Responses

Request samples

Content type
application/json
{
  • "username": "john",
  • "password": "12345"
}

Response samples

Content type
application/json
{
  • "username": "john",
  • "status": "ONLINE"
}

Delete a user

Delete a user

Authorizations:
bearerAuth
path Parameters
username
required
string
Example: john

Responses

Messages

Get all messages

Get all messages

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Post a message

Post a message

Authorizations:
bearerAuth
Request Body schema: text/plain
required
string

Responses

Request samples

Content type
text/plain
Hello

Response samples

Content type
application/json
{
  • "id": "8be4df61-93ca-11d2-aa0d-00e098032b8c",
  • "timestamp": "2026-05-01T12:00:00",
  • "username": "john",
  • "text": "Hello"
}

Delete a message

Delete a message

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>
Example: 8be4df61-93ca-11d2-aa0d-00e098032b8c

Responses