RuoYi Plus

https://plus-doc.dromara.org
Admin
RuoYi Plus is an enterprise-grade application framework offering multi-tenant and microservice-based...
Tokens:88,749
Snippets:713
Trust Score:8.8
Update:10 months ago
Show doc for...
Tokens:
Raw
### Frontend Project Setup and Run Commands

Source: https://plus-doc.dromara.org/index_/plus-ui/home

This section provides the necessary Git and NPM commands to clone the project, install dependencies, start the development server, and build the production environment. It assumes Node.js and npm are installed.

```bash
git clone https://gitee.com/JavaLionLi/plus-ui.git

npm install --registry=https://registry.npmmirror.com

npm run dev

npm run build:prod
```

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

### Start SkyWalking Services with Docker Compose

Source: https://plus-doc.dromara.org/index_/ruoyi-cloud-plus/extend-function/skywalking

This command initiates the SkyWalking services, including Elasticsearch, SkyWalking OAP (Observability Analysis Platform), and SkyWalking UI, using a docker-compose setup. Ensure Docker and docker-compose are installed and configured.

```bash
docker-compose up -d elasticsearch sky-oap sky-ui
```

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

### Docker Compose Command to Start Sharding Proxy

Source: https://plus-doc.dromara.org/index_/ruoyi-cloud-plus/extend-function/shardingproxy

Command to launch the Sharding-Proxy service using Docker Compose. It assumes the necessary `docker-compose.yml` file and `shardingproxy` configurations are present in the `docker` folder.

```bash
docker-compose up -d shardingproxy
```

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

### Starting ELK Stack with Docker Compose

Source: https://plus-doc.dromara.org/index_/ruoyi-cloud-plus/extend-function/elk

Command to launch the Elasticsearch, Kibana, and Logstash services using Docker Compose in detached mode.

```shell
docker-compose up -d elasticsearch kibana logstash
```

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

### Vue Router Basic Example

Source: https://plus-doc.dromara.org/index_/plus-ui/devdoc/router_use

Provides a standard configuration for a Vue.js route, including path, component, redirect, meta information like title and icon, and nested children routes. This is a typical setup for defining application views.

```javascript
{
  path: '/system/test',
  component: Layout,
  redirect: 'noRedirect',
  hidden: false,
  alwaysShow: true,
  meta: { title: '系统管理', icon : "system" },
  children: [{
    path: 'index',
    component: (resolve) => require(['@/views/index'], resolve),
    name: 'Test',
    meta: {
      title: '测试管理',
      icon: 'user'
    }
  }]
}
```

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

### Apifox-Helper IDEA Plugin Usage

Source: https://plus-doc.dromara.org/index_/ruoyi-vue-plus/framework/association/doc

Demonstrates the usage of the Apifox-Helper IDEA plugin for uploading API documentation. It covers plugin installation, interface display, module creation, and uploading API documentation directly from IDEA.

```java
// Example demonstrating plugin usage - actual code would be within the plugin's implementation.
// This is a conceptual representation of how one might interact with the plugin's features.

// Assuming the plugin provides an API or UI elements to:
// 1. Scan project for API annotations (e.g., @Operation, @Tag).
// 2. Create or select API modules within Apifox.
// 3. Upload the scanned API definitions to Apifox.

// User action example in IDEA:
// - Open Apifox-Helper panel.
// - Click 'Scan Project APIs'.
// - Select desired module or create a new one.
// - Click 'Upload to Apifox'.

// The plugin internally handles:
// - Parsing Javadoc and annotations.
// - Constructing OpenAPI schema.
// - Communicating with the Apifox API to upload the definition.

// For specific code, refer to the plugin's documentation and source code if available.
```

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

### API Documentation Generation (>= 1.2.0)

Source: https://plus-doc.dromara.org/index_/ruoyi-cloud-plus/framework/association/doc

Starting from version 1.2.0, the project migrates to the Springdoc framework for OpenAPI generation, supporting Javadoc for zero-invasion documentation. It recommends external tools like Apifox for a better UI and enhanced features.

```APIDOC
## API Documentation Generation (>= 1.2.0)

### Description

Starting from version 1.2.0, the project migrates to the `springdoc` framework for generating OpenAPI specifications. This approach leverages `javadoc` for zero-invasion documentation, creating a standardized `openapi` structure. Due to the limitations of the built-in UI, the project removes it, recommending external documentation tools for a superior user experience and extended capabilities.

### Method

N/A (Documentation Generation Process)

### Endpoint

N/A (Documentation Generation Process)

### Parameters

N/A

### Request Example

N/A

### Response

N/A

## Swagger to Springdoc Migration Guide

### Description

This section outlines the mapping between Swagger annotations and their Springdoc equivalents, along with how to utilize Javadoc for documentation generation. It highlights that Javadoc can replace basic annotations, but special features might still require annotations.

### Method

N/A (Annotation Mapping)

### Endpoint

N/A (Annotation Mapping)

### Parameters

#### Annotation Mapping Table

| Swagger Annotation      | Springdoc Annotation                     | Javadoc Equivalent (Class/Method/Parameter/Field Comment) |
| ----------------------- | ---------------------------------------- | ------------------------------------------------------- |
| `@Api(name = "xxx")`    | `@Tag(name = "xxx")`                   | First line of Java class comment                        |
| `@Api(description="xxx")`| `@Tag(description="xxx")`              | Java class comment                                      |
| `@ApiOperation`             | `@Operation`                             | Java method comment                                     |
| `@ApiIgnore`            | `@Hidden`                                | N/A                                                     |
| `@ApiParam`             | `@Parameter`                             | Java method `@param` parameter comment                  |
| `@ApiImplicitParam`     | `@Parameter`                             | Java method `@param` parameter comment                  |
| `@ApiImplicitParams`    | `@Parameters`                            | Multiple `@param` comments in Java method               |
| `@ApiModel`               | `@Schema`                                | Java entity class comment                               |
| `@ApiModelProperty`       | `@Schema`                                | Java property comment                                   |
| `@ApiModelProperty(hidden=true)` | `@Schema(accessMode = READ_ONLY)`       | N/A                                                     |
| `@ApiResponse`          | `@ApiResponse`                           | Java method `@return` return value comment              |

### Request Example

N/A

### Response

N/A

## Integrating with Apifox

### Description

This section details how to integrate your API documentation with Apifox, a comprehensive tool for API design, documentation, debugging, and testing. It covers two main integration methods: using OpenAPI specifications directly and employing the Apifox-Helper IDEA plugin.

### Method

N/A (Integration Guide)

### Endpoint

N/A (Integration Guide)

### Parameters

N/A

### Request Example

N/A

### Response

N/A

#### Using OpenAPI to Integrate with Apifox

##### Description

Steps to integrate your project's OpenAPI documentation into Apifox by creating a project, configuring data sources, and enabling automatic synchronization.

##### Method

N/A (OpenAPI Integration Steps)

##### Endpoint

`http://<gateway-ip>:<port>/<service-path>/v3/api-docs` (Example Data Source URL Format)

##### Parameters

- **Data Source URLs**:
  - `http://localhost:8080/demo/v3/api-docs` (Demo Service)
  - `http://localhost:8080/auth/v3/api-docs` (Authentication Service)
  - `http://localhost:8080/resource/v3/api-docs` (Resource Service)
  - `http://localhost:8080/system/v3/api-docs` (System Service)
  - `http://localhost:8080/code/v3/api-docs` (Code Generation Service)

- **Authentication Settings**:
  - Key: `Authorization` (Default, configurable based on project settings)
  - Version: `>= 2.X` or `1.X` (Refer to Apifox version for specific configuration)

##### Request Example

N/A

##### Response

N/A

#### Using Apifox-Helper IDEA Plugin

##### Description

Guidance on installing and using the Apifox-Helper IDEA plugin to streamline API documentation upload from your IDE. It covers plugin installation, interface usage, module creation, and uploading to Apifox.

##### Method

N/A (Plugin Usage Guide)

##### Endpoint

N/A (Plugin Usage Guide)

##### Parameters

- **Plugin Version**: `v2.0.13-243` (Latest recommended version at the time of writing)

##### Request Example

N/A

##### Response

N/A
```

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

### JavaScript WebSocket Headers Example

Source: https://plus-doc.dromara.org/index_/ruoyi-cloud-plus/framework/extend/websocket

This example demonstrates how to construct the headers for a WebSocket connection in JavaScript, including the Authorization token obtained after login and the client ID. This method is used when header transmission is supported.

```javascript
headers: {
    Authorization: "Bearer " + getToken(),
    clientid: import.meta.env.VITE_APP_CLIENT_ID
}

```

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

### Java Service for Workflow Node Expressions

Source: https://plus-doc.dromara.org/index_/ruoyi-vue-plus/quickstart/worker_init

Example of a Java service class demonstrating how to implement methods that can be called from Warm-Flow process node expressions using SPEL. It includes methods for retrieving a leader and another for passing workflow variables as parameters.

```java
import org.springframework.stereotype.Service;

@Service
// @Service("ssssss") // 重命名成自己喜欢的名字 方便书写查找 #{@ssssss.getLeader()}
public class DeptService {
    
    // 获取部门领导
    public String getLeader() {
        return "1";
    }

    // 获取其他流程变量当参数
    public String getLeader1(String handler1) {
        return "1";
    }
    
}
```

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

### MySQL Schema Creation for Sharding Tables

Source: https://plus-doc.dromara.org/index_/ruoyi-cloud-plus/extend-function/shardingproxy

SQL statements to create sharded tables (`t_order_0`, `t_order_1`, `t_order_item_0`, `t_order_item_1`) across two databases (`data-center_0`, `data-center_1`). These tables are designed for order and order item data, with primary and secondary indexes for efficient querying.

```sql
CREATE TABLE `t_order_0` (
  `order_id` bigint(20) UNSIGNED NOT NULL COMMENT '主键ID',
  `user_id` bigint(20) UNSIGNED NOT NULL COMMENT '用户ID',
  `total_money` int(10) UNSIGNED NOT NULL COMMENT '订单总金额',
  PRIMARY KEY (`order_id`),
  KEY `idx_user_id` (`user_id`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='订单总表';

CREATE TABLE `t_order_1` (
  `order_id` bigint(20) UNSIGNED NOT NULL COMMENT '主键ID',
  `user_id` bigint(20) UNSIGNED NOT NULL COMMENT '用户ID',
  `total_money` int(10) UNSIGNED NOT NULL COMMENT '订单总金额',
  PRIMARY KEY (`order_id`),
  KEY `idx_user_id` (`user_id`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='订单总表';

CREATE TABLE `t_order_item_0` (
  `order_item_id` bigint(20) UNSIGNED NOT NULL COMMENT '子订单ID',
  `order_id` bigint(20) UNSIGNED NOT NULL COMMENT '主键ID',
  `user_id` bigint(20) UNSIGNED NOT NULL COMMENT '用户ID',
  `money` int(10) UNSIGNED NOT NULL COMMENT '子订单金额',
  PRIMARY KEY (`order_item_id`),
  KEY `idx_order_id` (`order_id`) USING BTREE,
  KEY `idx_user_id` (`user_id`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='订单子表';

CREATE TABLE `t_order_item_1` (
  `order_item_id` bigint(20) UNSIGNED NOT NULL COMMENT '子订单ID',
  `order_id` bigint(20) UNSIGNED NOT NULL COMMENT '主键ID',
  `user_id` bigint(20) UNSIGNED NOT NULL COMMENT '用户ID',
  `money` int(10) UNSIGNED NOT NULL COMMENT '子订单金额',
  PRIMARY KEY (`order_item_id`),
  KEY `idx_order_id` (`order_id`) USING BTREE,
  KEY `idx_user_id` (`user_id`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='订单子表';
```

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

### Frontend SSE Connection Example

Source: https://plus-doc.dromara.org/index_/ruoyi-vue-plus/framework/extend/sse

Illustrates how a frontend application can establish a connection to the backend SSE endpoint. It shows the required URL format, including placeholders for backend IP, port, client ID, and authorization token. It also mentions that once connected, obtaining user information is consistent with other login methods within the framework.

```javascript
const backendIp = 'YOUR_BACKEND_IP'; // Replace with your backend IP
const port = 'YOUR_PORT'; // Replace with your backend port
const clientId = 'import.meta.env.VITE_APP_CLIENT_ID'; // Get client ID from environment variables
const token = 'Bearer YOUR_AUTH_TOKEN'; // Obtain this token after login

const sseUrl = `http://${backendIp}:${port}/resource/sse?clientid=${clientId}&Authorization=${token}`;

const eventSource = new EventSource(sseUrl);

eventSource.onopen = function() {
  console.log('SSE connection opened');
};

eventSource.onmessage = function(event) {
  console.log('Message received:', event.data);
  // Process the received message data
};

eventSource.onerror = function(err) {
  console.error('SSE error:', err);
  eventSource.close();
};

// To close the connection later:
// eventSource.close();

// Example of how to get user info after connection (assuming framework provides a method)
// async function getUserInfo() {
//   const userInfo = await framework.getCurrentUser();
//   console.log('Current user:', userInfo);
// }
// getUserInfo();

```

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

### WebSocket Client Connection Example

Source: https://plus-doc.dromara.org/index_/ruoyi-vue-plus/framework/extend/websocket

Demonstrates how a frontend client can connect to the WebSocket backend. It shows the connection URL format and how to pass authentication tokens and client IDs as URL parameters due to JavaScript's limitations in sending headers directly. This method is a workaround, and using headers is preferred if supported.

```text
ws://backend_ip:port/resource/websocket?clientid=import.meta.env.VITE_APP_CLIENT_ID&Authorization=Bearer eyJ0eXAiO......
```

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

### Java Service for Workflow Integration (Spring Boot)

Source: https://plus-doc.dromara.org/index_/ruoyi-cloud-plus/quickstart/worker_init

Example Java service demonstrating how to integrate with workflow processes using SpEL expressions for bean method invocation. This service is intended to be called from workflow definitions to retrieve dynamic data or perform actions.

```java
import org.springframework.stereotype.Service;

@Service
// @Service("ssssss") // Renamed to your preferred name for easier lookup, e.g., "#{@ssssss.getLeader()}"
public class DeptService {
    
    // Retrieves the department leader
    public String getLeader() {
        return "1";
    }

    // Retrieves other flow variables as parameters
    public String getLeader1(String handler1) {
        return "1";
    }
    
}
```

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

### Add SkyWalking Logging Dependency (Maven)

Source: https://plus-doc.dromara.org/index_/ruoyi-cloud-plus/extend-function/skywalking

This Maven dependency integrates SkyWalking's logging collection capabilities into your service. It relies on the 'ruoyi-common-skylog' artifact, which provides the necessary configurations and implementations for log forwarding to SkyWalking. Ensure your project uses Maven for dependency management.

```xml
<dependency>
    <groupId>com.ruoyi</groupId>
    <artifactId>ruoyi-common-skylog</artifactId>
</dependency>
```

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

### 创建基础Docker服务

Source: https://plus-doc.dromara.org/index_/ruoyi-vue-plus/quickstart/deploy

使用docker-compose启动项目的基础服务，包括MySQL、Nginx、Redis和Minio。

```bash
docker-compose up -d mysql nginx-web redis minio
```

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

### 创建Docker业务服务 (5.X)

Source: https://plus-doc.dromara.org/index_/ruoyi-vue-plus/quickstart/deploy

使用docker-compose启动项目业务服务的Docker镜像，适用于5.X版本。需要先构建服务镜像。

```bash
docker-compose up -d ruoyi-monitor-admin ruoyi-snailjob-server ruoyi-server1 ruoyi-server2
```

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

### Vue Local Component Registration

Source: https://plus-doc.dromara.org/index_/plus-ui/devdoc/component_use

Demonstrates how to locally register a Vue component within a specific page using the `<script setup>` syntax. This method imports a component and makes it available only within the template of the current component.

```vue
<script setup lang=ts>
import ComponentA from './ComponentA.vue'
</script>

<template>
  <ComponentA />
</template>
```

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

### 打包前端生产环境

Source: https://plus-doc.dromara.org/index_/ruoyi-vue-plus/quickstart/deploy

执行npm命令打包前端项目，生成用于生产环境的静态资源文件。

```bash
npm run build:prod
```

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

### 分配Docker目录权限

Source: https://plus-doc.dromara.org/index_/ruoyi-vue-plus/quickstart/deploy

为Docker容器分配对`/docker`目录及其子目录的写权限，确保文件上传和容器运行正常。如果遇到权限问题，重新执行此命令。

```bash
chmod -R 777 /docker
```

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

### 创建Docker业务服务 (4.X)

Source: https://plus-doc.dromara.org/index_/ruoyi-vue-plus/quickstart/deploy

使用docker-compose启动项目业务服务的Docker镜像，适用于4.X版本。需要先构建服务镜像。

```bash
docker-compose up -d ruoyi-monitor-admin ruoyi-xxl-job-admin ruoyi-server1 ruoyi-server2
```

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

### Custom Validation Annotation Example (@Xss)

Source: https://plus-doc.dromara.org/index_/ruoyi-cloud-plus/framework/basic/param_check

Shows how to create and use custom validation annotations, using `@Xss` as an example. This involves defining a custom annotation (e.g., `@Xss`) and implementing a corresponding `ConstraintValidator` to handle the specific validation logic. This allows for domain-specific validation rules to be incorporated into the parameter validation process.

```java
@Xss(message = "用户账号不能包含脚本字符")
@NotBlank(message = "用户账号不能为空")
@Size(min = 0, max = 30, message = "用户账号长度不能超过{max}个字符")
private String userName;

```

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

### Maven打包后端服务 (Jar包部署)

Source: https://plus-doc.dromara.org/index_/ruoyi-vue-plus/quickstart/deploy

使用Maven命令打包后端服务成可执行的jar包，用于手动部署。此命令跳过测试，并指定生产环境配置。

```bash
mvn clean package -D maven.test.skip=true -P prod
```

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

### Dromara 缓存操作 - TypeScript

Source: https://plus-doc.dromara.org/index_/plus-ui/devdoc/common_func

使用 $cache 对象处理会话级（sessionStorage）和本地级（localStorage）缓存。该对象提供了 set, get, setJSON, getJSON, remove 等方法，并建议使用此代理而非直接操作 sessionStorage/localStorage。

```typescript
// local 普通值
proxy?.$cache.local.set('key', 'local value')
console.log(proxy?.$cache.local.get('key')) // 输出'local value'

// session 普通值
proxy?.$cache.session.set('key', 'session value')
console.log(proxy?.$cache.session.get('key')) // 输出'session value'

// local JSON值
proxy?.$cache.local.setJSON('jsonKey', { localProp: 1 })
console.log(proxy?.$cache.local.getJSON('jsonKey')) // 输出'{localProp: 1}'

// session JSON值
proxy?.$cache.session.setJSON('jsonKey', { sessionProp: 1 })
console.log(proxy?.$cache.session.getJSON('jsonKey')) // 输出'{sessionProp: 1}'

// 删除值
proxy?.$cache.local.remove('key')
proxy?.$cache.session.remove('key')

```

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

### Table Pagination Component Usage

Source: https://plus-doc.dromara.org/index_/plus-ui/devdoc/component_doc

Example of integrating the Table Pagination component with an el-table. It demonstrates how to bind page and limit values, handle pagination events, and display data.

```html
<template>
  <div>
    <el-table :data="tableData">
      <el-table-column prop="date" label="日期" />
      <el-table-column prop="name" label="姓名" />
      <el-table-column prop="address" label="地址" />
    </el-table>
    <pagination 
       v-show="total > 0" 
       v-model:page="queryParams.pageNum" 
       v-model:limit="queryParams.pageSize" 
       :total="total" @pagination="getList" 
     />
  </div>
</template>

<script setup lang="ts">
import { ref, reactive } from 'vue';

const tableData = ref<any[]>([]);
const total = ref(0);
const queryParams = reactive({
    pageNum: 1,
    pageSize: 10
});
    
// 模拟异步请求获取数据
const getList = async () => {
  // 发送请求
  // const res = await getList(queryParams.value);
  // tableData.value = res.rows;
  // total.value = res.total;
  
  // Placeholder for actual data fetching
  tableData.value = [
    { date: '2023-01-01', name: '张三', address: '上海市普陀区' },
    { date: '2023-01-02', name: '李四', address: '北京市朝阳区' }
  ];
  total.value = 2;
};

// Initial data load
getList();

</script>
```

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

### Connecting to SSE

Source: https://plus-doc.dromara.org/index_/ruoyi-vue-plus/framework/extend/sse

Instructions on how to connect to the SSE endpoint from the frontend, including required parameters and authentication.

```APIDOC
## Connecting to SSE

### Description
This section describes how the frontend can establish a connection to the SSE endpoint.

### Method
GET

### Endpoint
`/resource/sse`

### Query Parameters
- **clientid** (string) - Required - The client ID, typically obtained from `import.meta.env.VITE_APP_CLIENT_ID`.
- **Authorization** (string) - Required - The authentication token, formatted as `Bearer YOUR_TOKEN`. This token needs to be obtained after user login.
```

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

### Get Enabled OssClient Instance - Java

Source: https://plus-doc.dromara.org/index_/ruoyi-cloud-plus/framework/basic/oss

Retrieves the currently enabled OssClient instance for performing operations. This is the primary method to interact with the configured OSS service.

```java
OssClient ossClient = OssFactory.instance();
// Perform operations using ossClient
```

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

### SSE Configuration and Usage

Source: https://plus-doc.dromara.org/index_/ruoyi-vue-plus/framework/extend/sse

Explains the configuration options for SSE, such as enabling/disabling the feature and setting the application path. It also demonstrates how to connect to the SSE endpoint and provides an overview of the message utility methods available for publishing and subscribing to messages.

```java
/**
 * SSE Configuration Properties
 */
public class SseProperties {
    private boolean enabled;
    private String path;

    // Getters and Setters
    public boolean isEnabled() {
        return enabled;
    }

    public void setEnabled(boolean enabled) {
        this.enabled = enabled;
    }

    public String getPath() {
        return path;
    }

    public void setPath(String path) {
        this.path = path;
    }
}

// Example usage in a service or controller
@Service
public class SseService {

    @Autowired
    private SseProperties sseProperties;

    public void handleSseRequest() {
        if (sseProperties.isEnabled()) {
            // SSE is enabled, proceed with connection handling
            System.out.println("SSE enabled. Path: " + sseProperties.getPath());
        } else {
            // SSE is disabled
            System.out.println("SSE is disabled.");
        }
    }
}

/**
 * SSE Message Utilities
 */
public class SseMessageUtils {

    /**
     * Pushes a single message to a specific client (special use cases).
     * @param clientId The ID of the client to send the message to.
     * @param message The message content.
     */
    public static void sendMessage(String clientId, String message) {
        // Implementation to send a single message
        System.out.println("Sending single message to " + clientId + ": " + message);
    }

    /**
     * Subscribes to distributed messages (usually done during framework initialization).
     */
    public static void subscribeMessage() {
        // Implementation to subscribe to distributed messages
        System.out.println("Subscribing to distributed messages.");
    }

    /**
     * Publishes a distributed message to all connected clients in the cluster (recommended).
     * @param message The message content to publish.
     */
    public static void publishMessage(String message) {
        // Implementation to publish a distributed message
        System.out.println("Publishing distributed message: " + message);
    }

    /**
     * Broadcasts a message to all connected clients.
     * @param message The message content to broadcast.
     */
    public static void publishAll(String message) {
        // Implementation to broadcast message to all clients
        System.out.println("Broadcasting message to all clients: " + message);
    }
}

```

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

### WebSocket Header Authentication Example

Source: https://plus-doc.dromara.org/index_/ruoyi-vue-plus/framework/extend/websocket

Illustrates how to construct request headers for WebSocket authentication, specifically for passing the Authorization token and client ID. This is presented as an alternative to URL parameters when the environment supports header transmission.

```javascript
{
    headers: {
        Authorization: "Bearer " + getToken(),
        clientid: import.meta.env.VITE_APP_CLIENT_ID
    }
}
```

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

### MinIO HTTPS Configuration - Nginx

Source: https://plus-doc.dromara.org/index_/ruoyi-cloud-plus/framework/basic/oss

Configuration example for MinIO to use HTTPS access. Note that the S3 API signature calculation algorithm does not support proxying MinIO Server API.

```nginx
# Example MinIO HTTPS configuration snippet
# This is a placeholder as the specific config was not provided in detail
server {
    listen 443 ssl;
    server_name your_domain.com;

    ssl_certificate /path/to/your/fullchain.pem;
    ssl_certificate_key /path/to/your/privkey.pem;

    location / {
        proxy_pass http://127.0.0.1:9000; # Assuming MinIO is running on port 9000
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}
```

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

### Vue Router External Link Example

Source: https://plus-doc.dromara.org/index_/plus-ui/devdoc/router_use

Demonstrates how to configure a route in Vue.js to link to an external website. It specifies the URL in the 'path' property and includes meta information for display, such as the title and icon.

```javascript
{
  path: 'http://ruoyi.vip',
  meta: { title: '若依官网', icon : "guide" }
}
```

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

### API 请求目录结构

Source: https://plus-doc.dromara.org/index_/plus-ui/devdoc/request_process

展示了API请求按照模型维度拆分的文件夹结构。统一的请求处理逻辑集中在`@/src/api`目录下，便于维护和管理。该结构支持按模块（如system, monitor）和子模块（如user, role）进行组织。

```tree
api/
  system/
    user/
      index.ts
      types.ts
    role/
      index.ts
      types.ts
  monitor/
    operlog/
      index.ts
      types.ts
    logininfor/
      index.ts
      types.ts
  ...
```

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

### Adding ELK Logging Dependency to Maven Project

Source: https://plus-doc.dromara.org/index_/ruoyi-cloud-plus/extend-function/elk

Maven dependency for integrating ELK log collection into a Spring Boot project. This requires adding the ruoyi-common-logstash artifact to the project's pom.xml.

```xml
<!-- ELK 日志收集 -->
<dependency>
    <groupId>com.ruoyi</groupId>
    <artifactId>ruoyi-common-logstash</artifactId>
</dependency>
```

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

### Get Enabled OssClient Instance - Java

Source: https://plus-doc.dromara.org/index_/ruoyi-vue-plus/framework/basic/oss

Obtain an instance of the currently enabled OssClient for interacting with cloud storage services. This is a factory method for accessing the configured storage client.

```java
OssClient ossClient = OssFactory.instance();
```

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

### Configuration

Source: https://plus-doc.dromara.org/index_/ruoyi-cloud-plus/framework/extend/websocket

Explains the configuration options for the WebSocket feature, located in the `ruoyi-resource` directory. Covers enabling/disabling the feature, setting the application path, and specifying allowed origins.

```APIDOC
## WebSocket Configuration

### Description
Details the configuration parameters for the WebSocket functionality, managed within the `ruoyi-resource` directory. Key settings include enabling the feature, defining the application path, and listing allowed origin addresses.

### Configuration File
`ruoyi-resource/application.yml` (or equivalent configuration file)

### Parameters
- **`enabled`** (boolean) - Controls whether the WebSocket feature is active. Set to `true` to enable, `false` to disable.
- **`path`** (string) - Specifies the application path for WebSocket connections.
- **`allowedOrigins`** (list of strings) - Defines a list of permitted origin addresses that are allowed to connect to the WebSocket server.

### Important Note
If disabling the WebSocket feature, ensure that the corresponding frontend WebSocket switch is also turned off. Failure to do so may result in errors during frontend startup.
```

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

### Data Permission Annotation Example

Source: https://plus-doc.dromara.org/index_/ruoyi-vue-plus/framework/basic/permissions

This code illustrates how to apply data permission annotations in a list query. It specifies fields like `dept_id` for department filtering and `user_id` for user filtering, indicating the mapper layer is the intended place for these annotations.

```java
> 标注数据权限注解 `dept_id` 为过滤部门字段 `user_id` 为过滤创建用户
```

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

### Swagger to Springdoc Migration Guide

Source: https://plus-doc.dromara.org/index_/ruoyi-vue-plus/framework/association/doc

Provides a mapping between Swagger annotations and their Springdoc equivalents, along with guidance on using Javadoc for OpenAPI generation. Note that Javadoc can replace basic functionality, but special cases may still require annotations.

```markdown
swagger | springdoc | javadoc  
---|---|--  
@Api(name = "xxx") | @Tag(name = "xxx") | java类注释第一行  
@Api(description= "xxx") | @Tag(description= "xxx") | java类注释  
@ApiOperation | @Operation | java方法注释  
@ApiIgnore | @Hidden | 无  
@ApiParam | @Parameter | java方法@param参数注释  
@ApiImplicitParam | @Parameter | java方法@param参数注释  
@ApiImplicitParams | @Parameters | 多个@param参数注释  
@ApiModel | @Schema | java实体类注释  
@ApiModelProperty | @Schema | java属性注释  
@ApiModelProperty(hidden = true) | @Schema(accessMode = READ_ONLY) | 无  
@ApiResponse | @ApiResponse | java方法@return返回值注释  
```

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

### Configuration Steps

Source: https://plus-doc.dromara.org/index_/questions/login_step

Instructions on how to modify configuration files to disable API encryption and verification codes.

```APIDOC
## Configuration Modifications

### Disable API Encryption
1. Modify the backend configuration file `application.yml`.
2. Modify the frontend configuration files `.env.development` or `.env.production`.

### Disable Verification Code
Modify the backend configuration file `application.yml` to disable verification codes if they are inconvenient.
```
Tokens:
Raw