RuoYi-Cloud

https://github.com/yangzongzhuan/ruoyi-cloud
Admin
RuoYi-Cloud is an open-source distributed microservices framework built on Spring Boot, Spring Cloud...
Tokens:31,747
Snippets:435
Trust Score:9.3
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Login Example Usage

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/endpoints.md

Example cURL command to authenticate a user.

```bash
curl -X POST http://localhost:9200/login \
  -H "Content-Type: application/json" \
  -d '{
    "username": "admin",
    "password": "admin123"
  }'
```

--------------------------------

### Pagination Query Example

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/endpoints.md

Example request demonstrating the use of pagination and sorting parameters.

```http
GET /system/users?pageNum=1&pageSize=20&orderByColumn=createTime&isAsc=desc
```

--------------------------------

### Usage Example for recordUserLogin

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/remote-services.md

Demonstrates how to record a user login event.

```java
public void recordLogin(Long userId, String loginIp) {
    SysUser user = new SysUser();
    user.setUserId(userId);
    user.setLoginIp(loginIp);
    user.setLoginDate(new Date());
    
    R<Boolean> result = remoteUserService.recordUserLogin(
        user, 
        SecurityConstants.INNER
    );
    
    if (R.isError(result)) {
        logger.error("Failed to record login: " + result.getMsg());
    }
}
```

--------------------------------

### Usage Example for registerUserInfo

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/remote-services.md

Demonstrates how to register a new user via the remote service.

```java
public void registerNewUser(String username, String password, String email) {
    SysUser user = new SysUser();
    user.setUserName(username);
    user.setPassword(password);
    user.setEmail(email);
    user.setStatus("0");
    
    R<Boolean> result = remoteUserService.registerUserInfo(
        user, 
        SecurityConstants.INNER
    );
    
    if (!R.isSuccess(result)) {
        throw new ServiceException("Registration failed");
    }
}
```

--------------------------------

### Initialize and Validate SysRole

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/types.md

Example demonstrating the instantiation of a SysRole object and the usage of the isAdmin check.

```java
SysRole role = new SysRole();
role.setRoleName("Manager");
role.setRoleKey("manager");
role.setDataScope("3");  // Department scope
role.setStatus("0");
role.setRoleSort(2);

// Check if admin
if (role.isAdmin()) {
    System.out.println("This is admin role");
}
```

--------------------------------

### Configure Admin Role

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/security-auth.md

Example of initializing a SysRole object with full administrative access.

```java
SysRole adminRole = new SysRole();
adminRole.setRoleId(1L);
adminRole.setRoleName("Administrator");
adminRole.setRoleKey("admin");
adminRole.setDataScope("1");  // Can see all data
adminRole.setPermissions(Set.of("*:*:*"));  // All permissions
```

--------------------------------

### Configure Manager Role

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/security-auth.md

Example of initializing a SysRole object with restricted department-level permissions.

```java
SysRole managerRole = new SysRole();
managerRole.setRoleId(2L);
managerRole.setRoleName("Manager");
managerRole.setRoleKey("manager");
managerRole.setDataScope("4");  // Department + subordinates
managerRole.setPermissions(Set.of(
    "system:user:list",
    "system:user:query",
    "system:dept:list",
    "system:dept:query"
));
```

--------------------------------

### Usage Example for getUserInfo

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/remote-services.md

Demonstrates how to invoke the remote user service within an authentication service.

```java
@Service
public class AuthenticationService {
    
    @Autowired
    private RemoteUserService remoteUserService;
    
    public LoginUser loadUserByUsername(String username) {
        R<LoginUser> response = remoteUserService.getUserInfo(
            username, 
            SecurityConstants.INNER
        );
        
        if (R.isSuccess(response)) {
            return response.getData();
        }
        throw new UsernameNotFoundException("User not found: " + username);
    }
}
```

--------------------------------

### Handle NotLoginException

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/errors.md

Example of catching a NotLoginException to return a failure response.

```java
try {
    resource = protectedService.getResource();
} catch (NotLoginException e) {
    // Redirect to login page
    return R.fail(401, "Please login first");
}
```

--------------------------------

### Delete File Usage Example

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/remote-services.md

Demonstrates how to call the delete method and handle potential service exceptions.

```java
public void removeFile(String fileId) {
    R<Boolean> result = remoteFileService.delete(fileId);
    
    if (!R.isSuccess(result)) {
        throw new ServiceException("Failed to delete file");
    }
}
```

--------------------------------

### Implement login log recording

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/remote-services.md

Example usage of RemoteLogService to record login events.

```java
public void recordLoginSuccess(String username, String ipaddr) {
    SysLogininfor log = new SysLogininfor();
    log.setUserName(username);
    log.setLoginIp(ipaddr);
    log.setLoginTime(new Date());
    log.setStatus(Constants.LOGIN_SUCCESS_STATUS);
    
    try {
        remoteLogService.saveLoginLog(log, SecurityConstants.INNER);
    } catch (Exception e) {
        logger.error("Failed to record login log", e);
    }
}
```

--------------------------------

### Register and Retrieve User

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/types.md

Example workflow for setting user properties, registering a user via remote service, and retrieving user information.

```java
SysUser user = new SysUser();
user.setUserName("john.doe");
user.setNickName("John Doe");
user.setEmail("john@example.com");
user.setPhonenumber("13800138000");
user.setStatus("0");
user.setDeptId(103L);

// Register user
R<Boolean> result = remoteUserService.registerUserInfo(user, SecurityConstants.INNER);

// Later, retrieve user
R<LoginUser> login = remoteUserService.getUserInfo("john.doe", SecurityConstants.INNER);
SysUser retrieved = login.getData().getSysUser();
```

--------------------------------

### Retrieve and Validate LoginUser

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/types.md

Example of retrieving the current user session and checking for specific permissions.

```java
LoginUser user = tokenService.getLoginUser();
if (user != null) {
    System.out.println("User: " + user.getUsername());
    System.out.println("ID: " + user.getUserid());
    System.out.println("Expires: " + new Date(user.getExpireTime()));
    
    if (user.getPermissions().contains("system:user:add")) {
        // User can add users
    }
}
```

--------------------------------

### Implement Profile Controller

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/token-authentication.md

Example usage of TokenService in a controller to retrieve the current user's profile information.

```java
@RestController
@RequestMapping("/profile")
public class ProfileController {
    
    @Autowired
    private TokenService tokenService;
    
    @GetMapping("/current")
    public R<LoginUser> getCurrentUser() {
        LoginUser user = tokenService.getLoginUser();
        if (user == null) {
            return R.fail("Not authenticated");
        }
        return R.ok(user);
    }
}
```

--------------------------------

### Upload File Usage Example

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/remote-services.md

Demonstrates how to inject and use RemoteFileService within a controller to handle file uploads.

```java
@RestController
@RequestMapping("/document")
public class DocumentController {
    
    @Autowired
    private RemoteFileService remoteFileService;
    
    @PostMapping("/attach")
    public R<String> uploadDocument(@RequestParam("file") MultipartFile file) {
        R<SysFile> response = remoteFileService.upload(file);
        
        if (R.isSuccess(response)) {
            SysFile fileInfo = response.getData();
            return R.ok(fileInfo.getFilePath(), "File uploaded successfully");
        }
        
        return R.fail(response.getMsg());
    }
}
```

--------------------------------

### Configure Environment Variables for RuoYi-Cloud

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/configuration.md

Use shell exports to override default configuration settings before starting the application.

```bash
export SPRING_PROFILES_ACTIVE=prod
export SPRING_DATASOURCE_URL=jdbc:mysql://prod-db:3306/ruoyi
export SPRING_REDIS_HOST=prod-redis
java -jar ruoyi-auth.jar
```

--------------------------------

### Implement Login Service

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/token-authentication.md

Example usage of TokenService within a login service to generate tokens after user authentication.

```java
@Service
public class LoginService {
    
    @Autowired
    private TokenService tokenService;
    
    public Map<String, Object> login(String username, String password) {
        // Authenticate user
        SysUser sysUser = userService.getUserByUsername(username);
        if (sysUser == null || !passwordEncoder.matches(password, sysUser.getPassword())) {
            throw new ServiceException("Invalid username or password");
        }
        
        // Build LoginUser object
        LoginUser loginUser = new LoginUser();
        loginUser.setSysUser(sysUser);
        loginUser.setPermissions(permissionService.getPermissions(sysUser.getUserId()));
        loginUser.setRoles(roleService.getRoles(sysUser.getUserId()));
        
        // Generate token
        Map<String, Object> tokenMap = tokenService.createToken(loginUser);
        return tokenMap;
    }
}
```

--------------------------------

### Configure Nacos for Multi-instance Setup

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/README.md

Define Nacos discovery settings in the production YAML configuration file.

```yaml
# application-prod.yml
spring:
  cloud:
    nacos:
      discovery:
        server-addr: nacos-cluster:8848
        namespace: production
        group: PROD_GROUP
```

--------------------------------

### Validate and Retrieve User

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/token-authentication.md

Example usage of verifyToken to ensure a token is valid before retrieving user data.

```java
public LoginUser validateAndGetUser(String token) {
    if (!tokenService.verifyToken(token)) {
        throw new ServiceException("Invalid or expired token");
    }
    
    // Token valid, retrieve user from Redis
    return tokenService.getLoginUser(token);
}
```

--------------------------------

### GET /system/user/list

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/README.md

Retrieves a list of users using an authenticated token.

```APIDOC
## GET /system/user/list

### Description
Retrieves the list of system users. Requires a valid Bearer token in the Authorization header.

### Method
GET

### Endpoint
/system/user/list
```

--------------------------------

### Trigger NotLoginException

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/errors.md

Example of throwing a NotLoginException when a user session is missing.

```java
LoginUser user = tokenService.getLoginUser();
if (user == null) {
    throw new NotLoginException();
}
```

--------------------------------

### Handle NotPermissionException

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/errors.md

Example of using @PreAuthorize to enforce permissions, which throws NotPermissionException automatically.

```java
@PreAuthorize("hasPermission('system:user:delete')")
@DeleteMapping("/{userId}")
public R<Boolean> deleteUser(@PathVariable Long userId) {
    // Throws NotPermissionException if user lacks permission
    return R.ok(true);
}
```

--------------------------------

### GET /user/info/{username}

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/remote-services.md

Retrieves user information by username for authentication purposes.

```APIDOC
## GET /user/info/{username}

### Description
Retrieves user information by username for authentication purposes.

### Method
GET

### Endpoint
/user/info/{username}

### Parameters
#### Path Parameters
- **username** (String) - Required - Username to query

#### Request Headers
- **FROM_SOURCE** (String) - Required - Request source identifier (typically "inner" for internal calls)

### Response
#### Success Response (200)
- **data** (LoginUser) - Response wrapper containing LoginUser data

#### Response Example
{
  "code": 200,
  "msg": null,
  "data": {
    "token": "uuid-string",
    "userid": 1,
    "username": "admin",
    "loginTime": 1234567890,
    "expireTime": 1234574890,
    "ipaddr": "192.168.1.1",
    "permissions": ["*:*:*"],
    "roles": ["admin"],
    "sysUser": {}
  }
}
```

--------------------------------

### JWT Payload Structure

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/token-authentication.md

Example of the claims contained within the JWT.

```json
{
  "user_key": "550e8400-e29b-41d4-a716-446655440000",
  "user_id": 1,
  "username": "admin"
}
```

--------------------------------

### Implement Authentication Filter

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/token-authentication.md

Example of using getLoginUser within a Servlet Filter to authenticate requests.

```java
@Component
public class AuthenticationFilter implements Filter {
    
    @Autowired
    private TokenService tokenService;
    
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        LoginUser user = tokenService.getLoginUser(httpRequest);
        
        if (user != null) {
            // User authenticated
            request.setAttribute("loginUser", user);
        }
        
        chain.doFilter(request, response);
    }
}
```

--------------------------------

### Implement operation log recording

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/remote-services.md

Example usage of RemoteLogService within an Aspect to capture operation logs.

```java
@Aspect
@Component
public class LogAspect {
    
    @Autowired
    private RemoteLogService remoteLogService;
    
    @Around("@annotation(com.ruoyi.common.log.annotation.Log)")
    public Object recordLog(ProceedingJoinPoint joinPoint) throws Throwable {
        Object result = joinPoint.proceed();
        
        SysOperLog log = new SysOperLog();
        log.setOperName("someOperation");
        log.setOperTime(new Date());
        log.setStatus("0");
        
        try {
            remoteLogService.saveLog(log, SecurityConstants.INNER);
        } catch (Exception e) {
            logger.error("Failed to save operation log", e);
        }
        
        return result;
    }
}
```

--------------------------------

### Throwing ServiceException

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/errors.md

Examples of throwing ServiceException with basic messages, custom codes, or chained detail messages.

```java
// Basic throw
if (user == null) {
    throw new ServiceException("User not found");
}

// With custom code
if (amount > balance) {
    throw new ServiceException("Insufficient balance", 402);
}

// With chaining
throw new ServiceException("User update failed")
    .setDetailMessage("Database constraint violation: duplicate username");
```

--------------------------------

### Refresh Token Controller Endpoint

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/token-authentication.md

Example controller endpoint that triggers a token refresh for an authenticated user.

```java
@PostMapping("/refresh")
public R<?> refreshToken(HttpServletRequest request) {
    LoginUser loginUser = tokenService.getLoginUser(request);
    if (loginUser != null) {
        // Extend token expiration
        tokenService.refreshToken(loginUser);
        return R.ok(null, "Token refreshed");
    }
    return R.fail("Token invalid or expired");
}
```

--------------------------------

### Get User Info Request Header

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/endpoints.md

Required header for internal service authentication.

```http
from-source: inner
```

--------------------------------

### Get User Info Success Response

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/endpoints.md

JSON structure returned upon successful retrieval of user details.

```json
{
  "code": 200,
  "msg": null,
  "data": {
    "token": "550e8400-e29b-41d4-a716-446655440000",
    "userid": 1,
    "username": "admin",
    "loginTime": 1629360600000,
    "expireTime": 1629404040000,
    "ipaddr": "192.168.1.100",
    "permissions": ["*:*:*"],
    "roles": ["admin"],
    "sysUser": {
      "userId": 1,
      "userName": "admin",
      "nickName": "Administrator",
      "email": "admin@example.com",
      "phonenumber": "15888888888",
      "sex": "0",
      "status": "0",
      "deptId": 100
    }
  }
}
```

--------------------------------

### GET /user/info/{username}

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/endpoints.md

Retrieves detailed user information for a specific username via an internal service call.

```APIDOC
## GET /user/info/{username}

### Description
Retrieves detailed user information for a specific username via an internal service call.

### Method
GET

### Endpoint
/user/info/{username}

### Parameters
#### Path Parameters
- **username** (String) - Required - Username to retrieve

### Request Headers
- **from-source**: inner

### Response
#### Success Response (200)
- **code** (Integer) - Status code
- **msg** (String) - Message
- **data** (Object) - User information object

#### Response Example
{
  "code": 200,
  "msg": null,
  "data": {
    "token": "550e8400-e29b-41d4-a716-446655440000",
    "userid": 1,
    "username": "admin",
    "loginTime": 1629360600000,
    "expireTime": 1629404040000,
    "ipaddr": "192.168.1.100",
    "permissions": ["*:*:*"],
    "roles": ["admin"],
    "sysUser": {
      "userId": 1,
      "userName": "admin",
      "nickName": "Administrator",
      "email": "admin@example.com",
      "phonenumber": "15888888888",
      "sex": "0",
      "status": "0",
      "deptId": 100
    }
  }
}
```

--------------------------------

### Get Login User Method Signature

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/token-authentication.md

The method signature for retrieving the currently authenticated user from the request context.

```java
public LoginUser getLoginUser()
```

--------------------------------

### Trigger NotRoleException

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/errors.md

Example of throwing a NotRoleException when a user does not have the required role.

```java
if (!user.getRoles().contains("admin")) {
    throw new NotRoleException("admin");
}
```

--------------------------------

### Trigger NotPermissionException

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/errors.md

Example of throwing a NotPermissionException when a specific permission is missing.

```java
if (!user.getPermissions().contains("system:user:delete")) {
    throw new NotPermissionException("system:user:delete");
}
```

--------------------------------

### Deploy RuoYi-Cloud Gateway with Docker

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/README.md

Run the gateway container with environment variables for Nacos discovery and MySQL database connectivity.

```bash
docker run -p 8080:8080 \
  -e SPRING_CLOUD_NACOS_DISCOVERY_SERVER_ADDR=nacos:8848 \
  -e SPRING_DATASOURCE_URL=jdbc:mysql://mysql:3306/ruoyi \
  ruoyi/ruoyi-gateway:latest
```

--------------------------------

### Configure Servlet and Server Settings

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/configuration.md

Sets application port, context path, encoding, and response compression parameters.

```yaml
server:
  port: 8080
  servlet:
    context-path: /
    encoding:
      charset: UTF-8
      force: true
  compression:
    enabled: true
    min-response-size: 1024
    mime-types: application/json,application/xml,text/html,text/xml,text/plain
```

--------------------------------

### Initialize SysUser Instance

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/types.md

Constructor usage for creating a SysUser instance with a specific user ID.

```java
SysUser user = new SysUser(1L);
```

--------------------------------

### POST /logininfor

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/remote-services.md

Records a login log entry into the system.

```APIDOC
## POST /logininfor

### Description
Records a login log entry.

### Method
POST

### Endpoint
/logininfor

### Parameters
#### Request Body
- **sysLogininfor** (SysLogininfor) - Required - Login log entry

#### Headers
- **FROM_SOURCE** (String) - Required - Request source identifier

### Response
#### Success Response (200)
- **data** (Boolean) - true if login log saved successfully
```

--------------------------------

### Configure Swagger API Documentation

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/configuration.md

Enables Swagger UI and configures path and sorting behavior for API documentation.

```yaml
springdoc:
  swagger-ui:
    enabled: true
    path: /swagger-ui.html
    operations-sorter: method
    tags-sorter: alpha
  api-docs:
    path: /v3/api-docs
```

--------------------------------

### POST /user/register

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/remote-services.md

Registers a new user in the system.

```APIDOC
## POST /user/register

### Description
Registers a new user in the system.

### Method
POST

### Endpoint
/user/register

### Parameters
#### Request Headers
- **FROM_SOURCE** (String) - Required - Request source identifier

#### Request Body
- **sysUser** (SysUser) - Required - User object with username, password, email, etc.

### Request Example
{
  "userName": "newuser",
  "nickName": "New User",
  "password": "encrypted-password",
  "email": "user@example.com",
  "phonenumber": "13800138000",
  "sex": "0",
  "status": "0",
  "deptId": 103
}

### Response
#### Success Response (200)
- **data** (Boolean) - true if registration successful
```

--------------------------------

### Configure Datasource

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/configuration.md

Define database connection parameters including URL, credentials, and driver class.

```yaml
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/ruoyi?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&serverTimezone=Asia/Shanghai&allowMultiQueries=true&allowPublicKeyRetrieval=true&useSSL=false
    username: root
    password: root
    driver-class-name: com.mysql.cj.jdbc.Driver
```

--------------------------------

### Configure Nacos Service Discovery and Config

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/configuration.md

Set up Nacos server addresses, namespaces, and configuration groups.

```yaml
spring:
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
        namespace: development
        group: DEFAULT_GROUP
      config:
        server-addr: localhost:8848
        namespace: development
        group: DEFAULT_GROUP
        file-extension: yml
        enabled: true
```

--------------------------------

### Get IP from Context

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/utilities.md

Retrieves the client IP address directly from the current servlet request context.

```java
String ip = IpUtils.getIpAddr();
// Automatically uses servlet context
```

--------------------------------

### Configure JPA and Hibernate

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/configuration.md

Set database dialect, DDL behavior, and SQL logging preferences.

```yaml
spring:
  jpa:
    database-platform: org.hibernate.dialect.MySQLDialect
    hibernate:
      ddl-auto: validate
    show-sql: false
    properties:
      hibernate:
        format_sql: true
```

--------------------------------

### Activate Configuration Profiles

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/configuration.md

Set the active profile via YAML configuration or command-line arguments.

```yaml
# application.yml
spring:
  profiles:
    active: dev
```

```bash
java -jar app.jar --spring.profiles.active=prod
```

--------------------------------

### Configure Redis Cache

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/configuration.md

Set up Redis connection details and connection pool settings.

```yaml
spring:
  redis:
    host: localhost
    port: 6379
    password: 
    timeout: 2000ms
    database: 0
    jedis:
      pool:
        max-active: 8
        max-idle: 8
        min-idle: 0
        max-wait: -1ms
```

--------------------------------

### POST /register

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/endpoints.md

Registers a new user account.

```APIDOC
## POST /register

### Description
Creates a new user account in the system.

### Method
POST

### Endpoint
/register

### Request Body
- **username** (String) - Required - Login username
- **password** (String) - Required - Raw password

### Request Example
{
  "username": "newuser",
  "password": "SecurePass123"
}

### Response
#### Success Response (200)
- **code** (Integer) - Status code 200
```

--------------------------------

### Minimal Service Configuration

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/README.md

Basic YAML configuration for a RuoYi-Cloud service, including Nacos discovery, datasource, and Redis settings.

```yaml
spring:
  application:
    name: ruoyi-auth
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
  datasource:
    url: jdbc:mysql://localhost:3306/ruoyi?useUnicode=true&characterEncoding=utf8&serverTimezone=Asia/Shanghai
    username: root
    password: root
    driver-class-name: com.mysql.cj.jdbc.Driver
  redis:
    host: localhost
    port: 6379

server:
  port: 9200
```

--------------------------------

### Define Permission String Format

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/security-auth.md

The standard format for defining hierarchical permissions.

```text
module:action:resource
```

--------------------------------

### Configure HTTPS in YAML

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/security-auth.md

Define SSL keystore settings within the server configuration.

```yaml
server:
  ssl:
    key-store: classpath:keystore.jks
    key-store-password: password
    key-store-type: JKS
```

--------------------------------

### Configure Feign Client

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/configuration.md

Sets timeouts and compression settings for Feign HTTP clients.

```yaml
feign:
  client:
    config:
      default:
        connect-timeout: 5000
        read-timeout: 5000
        logger-level: full
  compression:
    request:
      enabled: true
    response:
      enabled: true
```

--------------------------------

### Configure Gateway Module Routes

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/configuration.md

Sets up Spring Cloud Gateway routes with path predicates and Redis rate limiting filters.

```yaml
spring:
  cloud:
    gateway:
      routes:
        - id: ruoyi-system
          uri: lb://ruoyi-system
          predicates:
            - Path=/system/**
          filters:
            - name: RequestRateLimiter
              args:
                redis-rate-limiter.replenishRate: 100
                redis-rate-limiter.burstCapacity: 200
        - id: ruoyi-auth
          uri: lb://ruoyi-auth
          predicates:
            - Path=/login,/register,/refresh,/logout,/unlockscreen
```

--------------------------------

### Register Endpoint

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/endpoints.md

Public endpoint for creating a new user account.

```json
{
  "username": "newuser",
  "password": "SecurePass123"
}
```

```json
{
  "code": 200,
  "msg": null,
  "data": null
}
```

```bash
curl -X POST http://localhost:9200/register \
  -H "Content-Type: application/json" \
  -d '{
    "username": "newuser",
    "password": "SecurePass123"
  }'
```

--------------------------------

### Essential Application Properties

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/INDEX.md

Core YAML configuration settings for Nacos discovery, database connectivity, and Redis integration.

```yaml
spring:
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848
  datasource:
    url: jdbc:mysql://localhost:3306/ruoyi
  redis:
    host: localhost
```

--------------------------------

### Configure File Upload Settings

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/configuration.md

Defines file size limits, allowed extensions, and storage paths for the custom file module.

```yaml
ruoyi:
  file:
    max-size: 104857600  # 100MB
    allowed-extensions: pdf,doc,docx,xls,xlsx,jpg,jpeg,png,gif,zip,rar,7z
    upload-path: /profile/upload
    download-path: /profile/download
    resource-prefix: /profile
```

--------------------------------

### Create New User

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/README.md

Register a new user via the remote user service using internal security constants.

```java
SysUser newUser = new SysUser();
newUser.setUserName("john.doe");
newUser.setNickName("John Doe");
newUser.setPassword("encrypted-password");
newUser.setStatus("0");

R<Boolean> result = remoteUserService.registerUserInfo(
    newUser, 
    SecurityConstants.INNER
);
```

--------------------------------

### Configure Token Settings in YAML

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/token-authentication.md

Define token expiration and refresh thresholds in the application configuration file.

```yaml
ruoyi:
  token:
    expiration: 43200  # 12 hours
    refresh: 120       # 2 hours before expiration
```

--------------------------------

### Define registerUserInfo Feign Method

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/remote-services.md

Defines the Feign client method for registering a new user.

```java
@PostMapping("/user/register")
public R<Boolean> registerUserInfo(
    @RequestBody SysUser sysUser, 
    @RequestHeader(SecurityConstants.FROM_SOURCE) String source
);
```

--------------------------------

### Configure Logging Levels and Patterns

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/configuration.md

Configures log levels for specific packages, console/file patterns, and log file rotation settings.

```yaml
logging:
  level:
    root: INFO
    com.ruoyi: INFO
    com.alibaba.nacos: WARN
    org.springframework.cloud: WARN
  pattern:
    console: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n"
    file: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n"
  file:
    name: logs/ruoyi.log
    max-size: 100MB
    max-history: 30
```

--------------------------------

### Implement Wildcard Permission Matching

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/security-auth.md

Custom logic to support hierarchical permission checks including exact matches, superadmin overrides, and wildcard patterns.

```java
public boolean hasPermission(String requiredPermission) {
    LoginUser user = tokenService.getLoginUser();
    Set<String> permissions = user.getPermissions();
    
    if (permissions == null) return false;
    
    // Check exact match
    if (permissions.contains(requiredPermission)) return true;
    
    // Check superadmin
    if (permissions.contains("*:*:*")) return true;
    
    // Check wildcard matches
    String[] parts = requiredPermission.split(":");
    String moduleWildcard = parts[0] + ":*:*";
    String actionWildcard = parts[0] + ":" + parts[1] + ":*";
    
    return permissions.contains(moduleWildcard) || 
           permissions.contains(actionWildcard);
}
```

--------------------------------

### User Login Request

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/README.md

Perform a POST request to the login endpoint with user credentials to obtain an access token.

```bash
POST /login
Content-Type: application/json

{
  "username": "admin",
  "password": "admin123"
}
```

--------------------------------

### Configure Allowed File Extensions

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/errors.md

Define the list of permitted file extensions for uploads in the application configuration.

```yaml
ruoyi:
  file:
    allowed-extensions: pdf,doc,docx,xls,xlsx,jpg,jpeg,png,gif
```

--------------------------------

### POST /logininfor

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/endpoints.md

Saves a login log entry via an internal Feign call.

```APIDOC
## POST /logininfor

### Description
Records a login attempt log.

### Method
POST

### Endpoint
/logininfor

### Request Body
- **userName** (String) - Required - Username
- **loginIp** (String) - Required - Login IP
- **loginLocation** (String) - Required - Location
- **browser** (String) - Required - Browser info
- **os** (String) - Required - OS info
- **loginTime** (String) - Required - Timestamp
- **status** (String) - Required - Status
- **msg** (String) - Required - Message

### Response
#### Success Response (200)
- **code** (Integer) - Status code
- **data** (Boolean) - Success status
```

--------------------------------

### POST /login

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/endpoints.md

Authenticates a user and returns a JWT access token.

```APIDOC
## POST /login

### Description
Authenticates a user with their credentials and returns a JWT access token for subsequent requests.

### Method
POST

### Endpoint
/login

### Request Body
- **username** (String) - Required - User login name
- **password** (String) - Required - User password

### Request Example
{
  "username": "admin",
  "password": "admin123"
}

### Response
#### Success Response (200)
- **access_token** (String) - JWT token to use in Authorization header
- **expires_in** (Integer) - Token validity in seconds

#### Response Example
{
  "code": 200,
  "msg": null,
  "data": {
    "access_token": "eyJhbGciOiJIUzUxMiJ9...",
    "expires_in": 43200
  }
}
```

--------------------------------

### Login Process Flow

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/security-auth.md

Sequence of steps for authenticating a user and issuing a JWT.

```text
1. Client sends POST /login with username/password
   ↓
2. Auth Service validates credentials
   ↓
3. Auth Service queries System Service for user info
   ↓
4. TokenService generates JWT token
   ↓
5. LoginUser cached in Redis with TTL
   ↓
6. JWT and expiration returned to client
   ↓
7. Client includes "Authorization: Bearer <token>" in subsequent requests
```

--------------------------------

### Define Gradle Build Versions

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/configuration.md

Configures project versions using Gradle extension properties.

```gradle
ext {
    javaVersion = '17'
    springBootVersion = '4.0.0'
    springCloudVersion = '2023.0.0'
}
```

--------------------------------

### Define recordUserLogin Feign Method

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/remote-services.md

Defines the Feign client method for recording user login activity.

```java
@PutMapping("/user/recordlogin")
public R<Boolean> recordUserLogin(
    @RequestBody SysUser sysUser, 
    @RequestHeader(SecurityConstants.FROM_SOURCE) String source
);
```

--------------------------------

### Define saveLoginLog method

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/remote-services.md

Feign client method definition for recording login logs.

```java
@PostMapping("/logininfor")
public R<Boolean> saveLoginLog(
    @RequestBody SysLogininfor sysLogininfor, 
    @RequestHeader(SecurityConstants.FROM_SOURCE) String source
) throws Exception;
```

--------------------------------

### Configure File Size Limit

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/errors.md

Set the maximum allowed file size in bytes within the application configuration.

```yaml
ruoyi:
  file:
    max-size: 104857600  # 100MB in bytes
```

--------------------------------

### Define saveLog method

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/remote-services.md

Feign client method definition for recording operation logs.

```java
@PostMapping("/operlog")
public R<Boolean> saveLog(
    @RequestBody SysOperLog sysOperLog, 
    @RequestHeader(SecurityConstants.FROM_SOURCE) String source
) throws Exception;
```

--------------------------------

### Configure Security Properties

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/security-auth.md

Define JWT authentication parameters, rate limiting thresholds, and CORS policy settings.

```yaml
security:
  jwt:
    secret: your-secret-key-here-min-32-chars
    expiration: 43200
    refresh-threshold: 120
  rate-limit:
    enabled: true
    requests-per-minute: 1000
  cors:
    allowed-origins: http://localhost:8080,http://localhost:9090
    allowed-methods: GET,POST,PUT,DELETE,OPTIONS
    allowed-headers: "*"
```

--------------------------------

### POST /upload

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/remote-services.md

Uploads a file to the file service.

```APIDOC
## POST /upload

### Description
Uploads a file to the file service.

### Method
POST

### Endpoint
/upload

### Parameters
#### Request Body
- **file** (MultipartFile) - Required - File to upload

### Response
#### Success Response (200)
- **code** (Integer) - Status code
- **msg** (String) - Message
- **data** (Object) - File metadata containing fileId, fileName, originalName, filePath, fileSize, fileType, and createTime
```

--------------------------------

### Configure File Service Storage

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/configuration.md

Defines file upload paths, resource prefixes, and storage backend settings for local or MinIO storage.

```yaml
ruoyi:
  file:
    upload-path: /profile/upload
    download-path: /profile/download
    resource-prefix: /profile
    max-size: 104857600
    # Storage type: local or minio
    storage-type: local
    # For MinIO storage:
    minio:
      url: http://localhost:9000
      access-key: minioadmin
      secret-key: minioadmin
      bucket-name: ruoyi
```

--------------------------------

### POST /upload

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/endpoints.md

Uploads a file to the file service via an internal Feign call.

```APIDOC
## POST /upload

### Description
Uploads a file to the file service.

### Method
POST

### Endpoint
/upload

### Parameters
#### Request Body
- **file** (File) - Required - File to upload (multipart)

### Response
#### Success Response (200)
- **code** (Integer) - Status code
- **msg** (String) - Message
- **data** (Object) - File metadata including fileId, fileName, and filePath

#### Response Example
{
  "code": 200,
  "msg": null,
  "data": {
    "fileId": "550e8400-e29b-41d4-a716-446655440000",
    "fileName": "document.pdf",
    "originalName": "document.pdf",
    "filePath": "/profile/upload/2024/08/24/document.pdf",
    "fileSize": 1024000,
    "fileType": "pdf",
    "createTime": "2024-08-24T10:30:45"
  }
}
```

--------------------------------

### Create JWT Token in Java

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/utilities.md

Generates a signed JWT token using a map of claims.

```java
Map<String, Object> claims = new HashMap<>();
claims.put("user_key", "550e8400-e29b-41d4-a716-446655440000");
claims.put("user_id", 1L);
claims.put("username", "admin");

String token = JwtUtils.createToken(claims);
// Returns: eyJhbGciOiJIUzUxMiJ9.eyJ1c2VyX2tl...
```

--------------------------------

### POST /unlockscreen

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/endpoints.md

Verifies the user password to unlock the screen.

```APIDOC
## POST /unlockscreen

### Description
Validates the provided password against the current user's password to unlock the screen.

### Method
POST

### Endpoint
/unlockscreen

### Request Headers
- **Authorization** (String) - Required - Bearer <access_token>

### Request Body
- **password** (String) - Required - User password to verify

### Request Example
{
  "password": "admin123"
}

### Response
#### Success Response (200)
- **code** (Integer) - Status code 200
```

--------------------------------

### Configure Pagination with PageUtils

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/utilities.md

Converts a PageDomain object into a Mybatis Page object for database queries.

```java
PageDomain pageDomain = new PageDomain();
pageDomain.setPageNum(1);
pageDomain.setPageSize(20);

Page page = PageUtils.getPage(pageDomain);
// Now can use with mapper.selectByPage(page)
```

--------------------------------

### Configure Docker Compose for RuoYi-Cloud

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/configuration.md

Defines the multi-container environment including Nacos, MySQL, Redis, and the gateway service.

```yaml
version: '3.8'

services:
  nacos:
    image: nacos/nacos-server:latest
    environment:
      MODE: standalone
    ports:
      - "8848:8848"
    networks:
      - ruoyi

  mysql:
    image: mysql:8.0
    environment:
      MYSQL_ROOT_PASSWORD: root
      MYSQL_DATABASE: ruoyi
    ports:
      - "3306:3306"
    volumes:
      - ./sql:/docker-entrypoint-initdb.d
    networks:
      - ruoyi

  redis:
    image: redis:latest
    ports:
      - "6379:6379"
    networks:
      - ruoyi

  gateway:
    build: ./ruoyi-gateway
    ports:
      - "8080:8080"
    environment:
      SPRING_CLOUD_NACOS_DISCOVERY_SERVER_ADDR: nacos:8848
      SPRING_DATASOURCE_URL: jdbc:mysql://mysql:3306/ruoyi
      SPRING_REDIS_HOST: redis
    depends_on:
      - nacos
      - mysql
      - redis
    networks:
      - ruoyi

networks:
  ruoyi:
    driver: bridge
```

--------------------------------

### Define Kubernetes Deployment for Gateway

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/configuration.md

Configures the deployment manifest for the gateway service, including environment variables and liveness probes.

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: ruoyi-gateway
spec:
  replicas: 2
  selector:
    matchLabels:
      app: ruoyi-gateway
  template:
    metadata:
      labels:
        app: ruoyi-gateway
    spec:
      containers:
      - name: gateway
        image: ruoyi/ruoyi-gateway:latest
        ports:
        - containerPort: 8080
        env:
        - name: SPRING_CLOUD_NACOS_DISCOVERY_SERVER_ADDR
          value: "nacos-service:8848"
        - name: SPRING_DATASOURCE_URL
          valueFrom:
            configMapKeyRef:
              name: ruoyi-config
              key: datasource.url
        - name: SPRING_REDIS_HOST
          value: "redis-service"
        livenessProbe:
          httpGet:
            path: /
            port: 8080
          initialDelaySeconds: 30
          periodSeconds: 10
```

--------------------------------

### Upload File

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/README.md

Upload a file and retrieve the download URL from the response data.

```java
R<SysFile> response = remoteFileService.upload(multipartFile);
if (R.isSuccess(response)) {
    String downloadUrl = response.getData().getFilePath();
}
```

--------------------------------

### POST /operlog

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/remote-services.md

Records an operation log entry into the system.

```APIDOC
## POST /operlog

### Description
Records an operation log entry.

### Method
POST

### Endpoint
/operlog

### Parameters
#### Request Body
- **sysOperLog** (SysOperLog) - Required - Operation log entry

#### Headers
- **FROM_SOURCE** (String) - Required - Request source identifier

### Response
#### Success Response (200)
- **data** (Boolean) - true if log saved successfully
```

--------------------------------

### Success Response Methods

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/response-wrapper.md

Static factory methods for creating successful API responses.

```java
R<Void> response = R.ok();
// Response: {"code": 200, "msg": null, "data": null}
```

```java
SysUser user = new SysUser();
user.setUserId(1L);
user.setUserName("admin");

R<SysUser> response = R.ok(user);
// Response: {"code": 200, "msg": null, "data": {"userId": 1, "userName": "admin", ...}}
```

```java
R<Boolean> response = R.ok(true, "User created successfully");
// Response: {"code": 200, "msg": "User created successfully", "data": true}
```

--------------------------------

### registerUserInfo Request Body Schema

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/remote-services.md

Expected JSON structure for the user registration request body.

```json
{
  "userName": "newuser",
  "nickName": "New User",
  "password": "encrypted-password",
  "email": "user@example.com",
  "phonenumber": "13800138000",
  "sex": "0",
  "status": "0",
  "deptId": 103
}
```

--------------------------------

### Check User Permissions

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/token-authentication.md

Verify if the authenticated user has the required permission string, including support for wildcard permissions.

```java
public boolean hasPermission(String permission) {
    LoginUser user = tokenService.getLoginUser();
    if (user == null) return false;
    
    Set<String> permissions = user.getPermissions();
    return permissions != null && (
        permissions.contains("*:*:*") ||
        permissions.contains(permission)
    );
}
```

--------------------------------

### Record Client IP Address

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/utilities.md

Retrieve the client's IP address and update user login information.

```java
String clientIp = IpUtils.getIpAddr();
user.setLoginIp(clientIp);
userService.updateLoginInfo(user);
```

--------------------------------

### Register User Request Headers

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/endpoints.md

Required headers for internal user registration requests.

```http
from-source: inner
Content-Type: application/json
```

--------------------------------

### Log Exceptions

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/utilities.md

Capture and log exception details using ExceptionUtil.

```java
try {
    performOperation();
} catch (Exception e) {
    String details = ExceptionUtil.getExceptionMsg(e);
    logger.error("Operation failed", e);
}
```

--------------------------------

### Implementing Feign Fallback Patterns

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/errors.md

Use a fallback factory to handle service unavailability gracefully by returning a standard error response.

```java
// In Feign fallback factory
@Override
public RemoteUserService create(Throwable cause) {
    return new RemoteUserService() {
        @Override
        public R<LoginUser> getUserInfo(String username, String source) {
            logger.error("User service unavailable", cause);
            return R.fail(503, "Service temporarily unavailable");
        }
    };
}
```

--------------------------------

### ExceptionUtil.getExceptionMsg

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/utilities.md

Formats an exception into a readable string containing the message and stack trace.

```APIDOC
### Method
`public static String getExceptionMsg(Exception e)`

### Description
Gets formatted exception message and stack trace.

### Parameters
- **e** (Exception) - Required - Exception to format

### Return
- **String** - Formatted message with stack trace
```

--------------------------------

### Register User Success Response

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/endpoints.md

Standard success response for user registration.

```json
{
  "code": 200,
  "msg": null,
  "data": true
}
```

--------------------------------

### Pagination Query Parameters

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/endpoints.md

Standard query parameters supported by list and search endpoints for controlling pagination and sorting.

```APIDOC
## Pagination Query Parameters

### Description
List and search endpoints support standard pagination and sorting parameters to control the result set.

### Parameters
#### Query Parameters
- **pageNum** (Integer) - Optional - Current page number (default: 1)
- **pageSize** (Integer) - Optional - Records per page (default: 10)
- **orderByColumn** (String) - Optional - Column to sort by
- **isAsc** (String) - Optional - Sort direction: "asc" or "desc"

### Request Example
GET /system/users?pageNum=1&pageSize=20&orderByColumn=createTime&isAsc=desc
```

--------------------------------

### ServiceException Constructors

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/errors.md

Standard constructors for initializing ServiceException with messages and error codes.

```java
// Empty constructor (for deserialization)
public ServiceException()

// Message only
public ServiceException(String message)

// Message and code
public ServiceException(String message, Integer code)
```

--------------------------------

### Authentication Routes

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/endpoints.md

Endpoints for managing user sessions and registration, routed to the auth service.

```APIDOC
## POST /login

### Description
Authenticates a user and returns a JWT token.

### Method
POST

### Endpoint
/login

## DELETE /logout

### Description
Invalidates the current user session.

### Method
DELETE

### Endpoint
/logout

## POST /refresh

### Description
Refreshes the current JWT access token.

### Method
POST

### Endpoint
/refresh

## POST /register

### Description
Registers a new user account.

### Method
POST

### Endpoint
/register
```

--------------------------------

### NotLoginException Response Format

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/errors.md

The JSON structure returned when a user is not authenticated.

```json
{
  "code": 401,
  "msg": "Not logged in",
  "data": null
}
```

--------------------------------

### Using R<T> in REST Controllers

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/api-reference/response-wrapper.md

Standard implementation for returning standardized response objects from Spring Boot controller methods.

```java
@RestController
@RequestMapping("/user")
public class UserController {
    
    @PostMapping("/create")
    public R<SysUser> createUser(@RequestBody SysUser user) {
        // Validate and create user
        SysUser created = userService.save(user);
        return R.ok(created, "User created successfully");
    }
    
    @GetMapping("/{id}")
    public R<SysUser> getUser(@PathVariable Long id) {
        SysUser user = userService.findById(id);
        if (user == null) {
            return R.fail("User not found");
        }
        return R.ok(user);
    }
    
    @DeleteMapping("/{id}")
    public R<Boolean> deleteUser(@PathVariable Long id) {
        boolean deleted = userService.deleteById(id);
        return deleted ? R.ok(true) : R.fail("Delete failed");
    }
}
```

--------------------------------

### System Routes

Source: https://github.com/yangzongzhuan/ruoyi-cloud/blob/master/_autodocs/endpoints.md

General system management endpoints routed to the system service.

```APIDOC
## ALL /system/*

### Description
Access system service functionality.

### Method
ALL

### Endpoint
/system/*

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer <access_token>
```
Tokens:
Raw