User Module

Project: Pet Feeder | page_id: 1722

User Authentication Interface Documentation

Overview

• Base path: /api
• Documentation scope: only includes user interfaces that require JWT authentication
• Authentication method:
• The request header X-Token is read first
• Content-Type: application/json

Unified Response Format

{
  "code": 200,
  "msg": "Operation successful",
  "data": {}
}

Response Field Description

Common Authentication Failure Response Example

{
  "code": 401,
  "msg": "Not logged in or login expired",
  "data": null
}

{
  "code": 401,
  "msg": "Login has expired, please log in again",
  "data": null
}

1. User Logout

• Path: /api/user/logout
• Method: POST
• Authentication required: Yes

Request Headers

Description:

• This interface is a stateless logout. The server does not maintain a blacklist; the client deleting the token is regarded as a logout.

Request Body

No business parameters; an empty object can be passed:

{}

Success Response Example

{
  "code": 200,
  "msg": "Logout successful",
  "data": null
}

Response Parameter Description

2. Refresh Token

• Path: /api/user/refreshToken
• Method: POST
• Authentication required: Yes

Request Headers

Request Body

The current implementation does not read the business request body; an empty object can be passed:

{}

Success Response Example

{
  "code": 200,
  "msg": "Refresh successful",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.xxx.yyy",
    "expiresIn": 86400
  }
}

Response Parameter Description

Failure Response Example

{
  "code": 400,
  "msg": "User does not exist",
  "data": null
}

3. Change Password

• Path: /api/user/changePassword
• Method: POST
• Authentication required: Yes

Request Headers

Request Body Parameters

Request Example

{
  "oldPassword": "12345678",
  "newPassword": "newPass@2026"
}

Success Response Example

{
  "code": 200,
  "msg": "Password changed successfully",
  "data": null
}

Response Parameter Description

Failure Response Example

{
  "code": 400,
  "msg": "Parameter error",
  "data": null
}

{
  "code": 400,
  "msg": "Incorrect current password",
  "data": null
}

{
  "code": 400,
  "msg": "User does not exist",
  "data": null
}

4. Change Nickname

• Path: /api/user/updateNickname
• Method: POST
• Authentication required: Yes

Request Headers

Request Body Parameters

Request Example

{
  "nickname": "New nickname"
}

Success Response Example

{
  "code": 200,
  "msg": "Nickname changed successfully",
  "data": null
}

Response Parameter Description

Failure Response Example

{
  "code": 400,
  "msg": "Parameter error",
  "data": null
}

{
  "code": 400,
  "msg": "Nickname cannot be empty",
  "data": null
}

{
  "code": 400,
  "msg": "The nickname cannot exceed 30 characters",
  "data": null
}

Appendix

Authentication Header Usage Example

X-Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.xxx.yyy

Description

• All interface responses use a unified structure in which the business code is placed in the code field.
• Except for the FailWithHTTP scenario, most business failures still return HTTP 200; the client should use the code field to determine whether the call succeeded.
• The refresh Token interface currently only depends on the logged-in user identity and does not read the refreshToken request body field.