API docs by Redocly

Munchies User Service API (1.0)

Download OpenAPI specification:

Login a user

Authenticates a user with the provided email and password.

Request Body schema: application/json
required

Login payload containing identifier (`email` or `username`) and `password`.

email
required
string
password
required
string
username
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "result": {
    }
}

Register a new user

Registers a new user with the provided information and credentials.

Request Body schema: application/json
required

Registration payload containing user data and credentials data.

email
required
string
hashedPassword
required
string
role
required
string
saltValue
required
string
username
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "hashedPassword": "string",
  • "role": "string",
  • "saltValue": "string",
  • "username": "string"
}

Update user info

Updates the profile information for a user.

Request Body schema: application/json
required

Payload containing the updated user profile information.

required
object (UserDTO)

Responses

Request samples

Content type
application/json
{
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "result": "string"
}

Update user password

Updates the password for a user with the provided old and new passwords.

Request Body schema: application/json
required

Password update payload containing user, old password, and new password.

email
required
string
id
required
string
newPassword
required
string
oldHashedPassword
required
string
username
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "id": "string",
  • "newPassword": "string",
  • "oldHashedPassword": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "result": "string"
}

Confirm a user's email address

The user inputs a specific otk received in the email

Request Body schema: application/json
required

Verification payload containing the user identifier and OTP/key.

id
required
string
otk
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "otk": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "result": "string"
}

Get user by id

Retrieves a user by their unique identifier.

path Parameters
id
required
string

The user identifier received from the path.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "result": {
    }
}

Deletes a user.

Deletes a user from an id

path Parameters
id
required
string

The user identifier from the path.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "result": {
    }
}