magic-api

https://www.ssssssss.org/magic-api/pages/
Admin
magic-api is a Java-based rapid interface development framework that allows creating HTTP API...
Tokens:8,912
Snippets:121
Trust Score:7.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### get

Source: https://www.ssssssss.org/magic-api/pages/module/request

Obtains the MagicHttpServletRequest object, providing access to detailed request information.

```APIDOC
## get

### Description
Retrieves the MagicHttpServletRequest object.

### Return Value
- **MagicHttpServletRequest** - The request object.

### Example
```python
import request
request.get()
```
```

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

### Get Uploaded File in Script

Source: https://www.ssssssss.org/magic-api/pages/faq

Utilize the `request` module to retrieve uploaded files by their name.

```python
import request;
request.getFile('name');

```

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

### Get Request Object

Source: https://www.ssssssss.org/magic-api/pages/module/request

Retrieves the main MagicHttpServletRequest object for the current request. This provides access to all request-related information.

```python
import request;
request.get();
```

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

### Get Array Parameters in Script

Source: https://www.ssssssss.org/magic-api/pages/faq

Use the `request` module to retrieve array parameters by their name.

```python
import request;
return request.getValues('name');

```

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

### Get Request Header Values

Source: https://www.ssssssss.org/magic-api/pages/module/request

Retrieves all string values for a specific request header. Use when a header might have multiple values.

```python
import request;
return request.getHeaders('xxx');
```

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

### Get Client IP Address

Source: https://www.ssssssss.org/magic-api/pages/module/request

Retrieves the IP address of the client making the request. This is useful for logging or geo-location purposes.

```python
import request;
return request.getClientIP();
```

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

### Get Multiple File Uploads

Source: https://www.ssssssss.org/magic-api/pages/module/request

Retrieves a collection of files uploaded via a form field. Use when expecting multiple files per field.

```python
import request;
request.getFiles('image');
```

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

### Get Array Parameter Values

Source: https://www.ssssssss.org/magic-api/pages/module/request

Retrieves all string values submitted for a given form parameter name. Useful for parameters that can have multiple values.

```python
import request;
return request.getValues('name');
```

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

### Get Single File Upload

Source: https://www.ssssssss.org/magic-api/pages/module/request

Retrieves a single file uploaded via a form field. Use when expecting one file per field.

```python
import request;
request.getFile('image');
```

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

### Configure Multi-Datasource with Java Code

Source: https://www.ssssssss.org/magic-api/pages/faq

Set up multiple data sources using `MagicDynamicDataSource` in Java. A default data source must be set, and others can be added with aliases.

```java
@Bean
public MagicDynamicDataSource magicDynamicDataSource(){
    MagicDynamicDataSource dynamicDataSource = new MagicDynamicDataSource();
    // 设置默认数据源（默认数据源一定要设置）
    dynamicDataSource.setDefault(ds1);
    dynamicDataSource.add("slave",ds2);
    return dynamicDataSource;
}

```

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

### Frontend Entry Point for Magic API

Source: https://www.ssssssss.org/magic-api/pages/plugin/dev

Initializes Magic API by adding internationalization messages and defining resources for the UI.

```javascript
import MagicTask from './service/magic-task.js'
import localZhCN from './i18n/zh-cn.js'
import localEn from './i18n/en.js'
import MagicTaskInfo from './components/magic-task-info.vue'
import 'vite-plugin-svg-icons/register'
export default (opt) => {
    const i18n = opt.i18n
    // 添加i18n 国际化信息
    i18n.add('zh-cn', localZhCN)
    i18n.add('en', localEn)
    return {
        // 左侧资源
        resource: [{
            // 资源类型，和后端存储结构一致
            type: 'task',
            // 展示图标
            icon: '#magic-task-task',   // #开头表示图标在插件中
            // 展示名称
            title: 'task.name',
            // 运行服务
            service: MagicTask(opt.bus, opt.constants, i18n.format, opt.Message, opt.request),
        }],
        // 右侧资源
        // datasources: [{
        //     // 资源类型，和后端存储结构一致
        //     type: 'redis',
        //     // 展示图标
        //     icon: '#magic-redis-redis',   // #开头表示图标在插件中
        //     // 展示标题
        //     title: 'Redis',
        //     // 展示名称
        //     name: i18n.format('redis.name'),
        //     // 表单组件
        //     component: MagicDataResourceRedis
        // }]
        // 底部工具条
        toolbars: [{
            // 当打开的资源类型为 task 时显示
            type: 'task',
            // 工具条展示的标题
            title: 'task.title',
            // 展示图标
            icon: 'parameter',
            // 对应的组件
            component: MagicTaskInfo,
        }]
    }
}
```

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

### Project Dependencies

Source: https://www.ssssssss.org/magic-api/pages/plugin/dev

Defines the project's name, version, main file, and development dependencies using Vite.

```json
{
  "name": "magic-test",
  "version": "1.0.0",
  "main": "magic-api.js",
  "scripts": {
    "build": "vite build"
  },
  "devDependencies": {
    "vue": "^3.2.31",
    "@vitejs/plugin-vue": "^2.2.4",
    "vite-plugin-svg-icons": "^1.1.0",
    "vite": "^2.8.6"
  }
}
```

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

### Magic API Service Implementation

Source: https://www.ssssssss.org/magic-api/pages/plugin/dev

Defines the service logic for a 'task' resource, including icon retrieval, name, language, and test execution.

```javascript
export default function (bus, constants, $i, Message, request) {
    return {
        // svg text
        getIcon: item => ['TASK', '#9012FE'],
        // 任务名称
        name: $i('task.name'),
        // 脚本语言
        language: 'magicscript',
        // 执行测试的逻辑
        doTest: (opened) => {
            opened.running = true
            const info = opened.item
            const requestConfig = {
                baseURL: constants.SERVER_URL,
                url: '/task/execute',
                method: 'POST',
                responseType: 'json',
                headers: {},
                withCredentials: true
            }
            bus.$emit(Message.SWITCH_TOOLBAR, 'log')
            requestConfig.headers[constants.HEADER_REQUEST_CLIENT_ID] = constants.CLIENT_ID
            requestConfig.headers[constants.HEADER_REQUEST_SCRIPT_ID] = opened.item.id
            requestConfig.headers[constants.HEADER_MAGIC_TOKEN] = constants.HEADER_MAGIC_TOKEN_VALUE
            // 设置断点
            requestConfig.headers[constants.HEADER_REQUEST_BREAKPOINTS] = (opened.decorations || []).filter(it => it.options.linesDecorationsClassName === 'breakpoints').map(it => it.range.startLineNumber).join(',')
            const fullName = opened.path()
            bus.status(`开始测试定时任务「${fullName}」`)
            request.sendPost('/task/execute', { id: info.id }, requestConfig).success(res => {
                opened.running = false
            }).end(() => {
                bus.status(`定时任务「${fullName}」测试完毕`)
                opened.running = false
            })
        },
        // 是否允许执行测试
        runnable: true,
        // 是否需要填写路径
        requirePath: true,
        // 合并
        merge: item => item
    }
}
```

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

### Type Conversion with Default Values

Source: https://www.ssssssss.org/magic-api/pages/base/script

Shows how to perform type conversions using the ::type(defaultValue) syntax. Provides a default value if the conversion fails.

```Magic API
var a = "123"::int;
var b = "abc"::int(111);
var c = "2020-01-01"::date('yyyy-MM-dd');
```

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

### Configure Global Module Import

Source: https://www.ssssssss.org/magic-api/pages/senior/module

Automatically import modules by listing them in the `magic-api.auto-import-module` property within `application.yaml`. Include 'db' if database modules are also needed.

```yaml
# org.ssssssss.magicapi.spring.boot.starter.MagicAPIProperties#autoImportModule 
# 覆盖默认配置时候别忘了加上db (如果不需要可忽略)
magic-api:
  auto-import-module: db,test

```

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

### Configure WebSocket for Debugging and Logging

Source: https://www.ssssssss.org/magic-api/pages/faq

Ensure WebSocket support for debugging and logging features. Configure proxies like Nginx to handle WebSocket connections.

```nginx
location /magic/web/console {
    proxy_pass http://localhost:9999;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";
    proxy_read_timeout 900s;
}

```

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

### Enable Static Resource Compression

Source: https://www.ssssssss.org/magic-api/pages/faq

Improve page loading speed by enabling server-side compression for static resources. Configure minimum response size for compression.

```properties
server.compression.enabled=true #启用压缩
server.compression.min-response-size=256 #大于256kb时压缩

```

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

### Magic-Script 'asm' Branch Dependency (v1.3.8)

Source: https://www.ssssssss.org/magic-api/pages/changelog/v1

Instructions for adding the magic-script 'asm' branch dependency for version 1.3.8 of magic-api-spring-boot-starter.

```xml
<dependency>
    <groupId>org.ssssssss</groupId>
    <artifactId>magic-api-spring-boot-starter</artifactId>
    <version>1.3.8</version>
    <exclusions>
        <exclusion>
            <groupId>org.ssssssss</groupId>
            <artifactId>magic-script</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.ssssssss</groupId>
    <artifactId>magic-script</artifactId>
    <version>1.5.0-beta3</version>
</dependency>
```

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

### Spread Syntax for Lists and Maps

Source: https://www.ssssssss.org/magic-api/pages/base/script

Demonstrates the spread syntax (...) for expanding lists and maps within other lists or maps, and for passing list elements as arguments to functions.

```Magic API
var sum = (a,b,c) => a + b + c;
System.out.println(sum(...[1,2,3]));

var arr = [3,4,5];
System.out.println([1,2,...arr,6,7]);

var map = {key2:2};
System.out.println({key1:1,...map,key3:3});
```

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

### Magic-Script 'asm' Branch Dependency (v1.3.9)

Source: https://www.ssssssss.org/magic-api/pages/changelog/v1

Instructions for adding the magic-script 'asm' branch dependency for version 1.3.9 of magic-api-spring-boot-starter.

```xml
<dependency>
    <groupId>org.ssssssss</groupId>
    <artifactId>magic-api-spring-boot-starter</artifactId>
    <version>1.3.9</version>
    <exclusions>
        <exclusion>
            <groupId>org.ssssssss</groupId>
            <artifactId>magic-script</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.ssssssss</groupId>
    <artifactId>magic-script</artifactId>
    <version>1.5.0-beta4</version>
</dependency>
```

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

### List Expansion into Map

Source: https://www.ssssssss.org/magic-api/pages/base/script

Shows how a list can be expanded into a map using the spread syntax, where list elements become values with numeric string keys.

```Magic API
var arr = [3,4,5];
System.out.println({key1:1,...arr});
```

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

### Switching Data Sources in Scripts

Source: https://www.ssssssss.org/magic-api/pages/faq

Access different data sources within scripts using dot notation. Use the default data source by calling `db.select()`, or a named data source like `db.slave.select()`.

```javascript
db.select('select * from sys_user');  //使用默认数据源
db.slave.select('select * from sys_user');  //使用slave数据源

```

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

### Manually Loop to Build SQL with Parameters

Source: https://www.ssssssss.org/magic-api/pages/faq

Manually loop through a list to construct SQL queries, concatenating conditions with `OR` or `AND` as needed. This provides more control over complex query construction.

```javascript
var list = [1,2,3,4,5];
var sql = "select * from sys_user where ";
for(index,item in list){
    sql = sql + 'id = #{list['+index+']}';
    if(index + 1 < list.size()){
        sql = sql + ' or ';
    }   
}
return db.select(sql);

```

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

### Vite Configuration for Magic API

Source: https://www.ssssssss.org/magic-api/pages/plugin/dev

Configures Vite for building the Magic API library, including build options, external dependencies, and plugins.

```javascript
import vue from '@vitejs/plugin-vue'
import viteSvgIcons from 'vite-plugin-svg-icons'
import path from 'path'
import pkg from './package.json'

export default {
    base: './',
    build: {
        minify: false,
        cssCodeSplit: true, // 将组件的 style 打包到 js 文件中
        outDir: 'dist',
        lib: {
            target: 'esnext',
            formats: ['iife'],
            entry: path.resolve(__dirname, 'src/magic-api.js'),
            name: 'MagicTask',
            fileName: (format) => `magic-task.${pkg.version}.${format}.js`
        },
        rollupOptions: {
            // 确保外部化处理那些你不想打包进库的依赖
            external: ['vue'],
            output: {
                // 在 UMD 构建模式下为这些外部化的依赖提供一个全局变量
                globals: {
                    vue: 'Vue'
                }
            }
        }
    },
    plugins: [
        vue(),
        viteSvgIcons({
			iconDirs: [path.resolve(process.cwd(), 'src/icons')],
			symbolId: 'magic-task-[name]'
		}),
    ]
}
```

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

### Use Custom Module in Script

Source: https://www.ssssssss.org/magic-api/pages/senior/module

Import and use functions from a custom module within a script. Ensure the module is imported using its defined name.

```script
import test;    //导入模块
test.println('Custom Module!'); 

```

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

### Logical Operators: AND, OR, and NOT

Source: https://www.ssssssss.org/magic-api/pages/base/script

Explains the usage of logical AND (&&), OR (||), and NOT (!) operators, including their short-circuiting behavior. Supports non-boolean operands in versions 0.4.6+.

```Magic API
var result1 = true && false;
var result2 = true || false;
var result3 = !true;
```

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

### Unary Operators: Negation and Boolean Inversion

Source: https://www.ssssssss.org/magic-api/pages/base/script

Demonstrates the use of the unary negation operator (-) for numbers and the logical NOT operator (!) for boolean expressions.

```Magic API
var a = -234;
var b = !true;
```

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

### SQL Injection Prevention: #{} vs ${}

Source: https://www.ssssssss.org/magic-api/pages/faq

Understand the difference between `${}` and `#{}` for SQL parameter binding. `${}` is prone to SQL injection, while `#{}` uses placeholders, similar to Mybatis.

```plaintext
主要区别在于`${}`用于拼接SQL(会产生SQL注入问题)，`#{}`会替换成占位符（不会产生SQL注入问题），这里的区别与`Mybatis`一致

```

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

### Define Custom Java Module

Source: https://www.ssssssss.org/magic-api/pages/senior/module

Create a Java class annotated with @Component and @MagicModule to define a custom module. Use @Comment for method and parameter documentation.

```java
import org.ssssssss.script.annotation.Comment;
@Component  //注入到Spring容器中
@MagicModule("test")    // 模块名称
public class TestFunctions {

    /**
    *   调用打印方法
    */
    @Comment("方法名的注释(用于提示)")
	public void println(@Comment("参数名的提示(用于提示)")String value) {
		System.out.println(value);
	}
}
```

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

### Save Blob Image Data to Database

Source: https://www.ssssssss.org/magic-api/pages/faq

Insert binary image data into a database table using a SQL statement. The `::sql('blob')` type conversion is used for the image column.

```sql
var sql = """
	insert into img_table(
    	img 
    )
	values(
    	#{img::sql('blob')}
    )
"""
```

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

### Spring Boot Auto-configuration

Source: https://www.ssssssss.org/magic-api/pages/plugin/dev

Configuration for Spring Boot auto-configuration to enable Magic API task services.

```properties
org.springframework.boot.autoconfigure.EnableAutoConfiguration=org.ssssssss.magicapi.task.starter.MagicAPITaskConfiguration
```

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

### Arithmetic Operators and Compound Assignment

Source: https://www.ssssssss.org/magic-api/pages/base/script

Shows common arithmetic operations and compound assignment operators like +=, -=, *=, /=, and %=.

```Magic API
var result = 1 + 2 * 3 / 4 % 2;
var x = 5;
x += 3; // x is now 8
```

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

### getFiles

Source: https://www.ssssssss.org/magic-api/pages/module/request

Retrieves a collection of uploaded files by their name. This is suitable for handling multiple files with the same identifier.

```APIDOC
## getFiles

### Description
Retrieves a collection of uploaded files by their name.

### Parameters
#### Path Parameters
- **name** (String) - Required - The name of the files to retrieve.

### Return Value
- **List<MultipartFile>** - A list of uploaded files.

### Example
```python
import request
request.getFiles('image')
```
```

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

### getClientIP

Source: https://www.ssssssss.org/magic-api/pages/module/request

Determines and returns the IP address of the client making the request.

```APIDOC
## getClientIP

### Description
Retrieves the IP address of the client making the request.

### Return Value
- **String** - The client's IP address.

### Example
```python
import request
return request.getClientIP()
```
```

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

### Retrieve Header Parameters in Script

Source: https://www.ssssssss.org/magic-api/pages/faq

Access request header parameters within scripts using `header.xxx` notation.

```plaintext
脚本中使用`header.xxx`获取`Header`中的参数 `SQL`中使用`#{header.xxx}`或`${header.xxx}`获取`Header`中的参数

```

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

### Implement Permission Interceptor

Source: https://www.ssssssss.org/magic-api/pages/faq

Implement a custom `RequestInterceptor` to handle API permissions. Permissions can be configured via interface options.

```java
@Component
@Order(1)   //拦截器顺序
public class PermissionInterceptor implements RequestInterceptor {

    @Override
    public Object preHandle(ApiInfo info, MagicScriptContext context, MagicHttpServletRequest request, MagicHttpServletResponse response) {
        // 获取配置的接口选项属性
        String permissionCode = info.getOptionValue(Options.PERMISSION);
        // 执行自己的代码逻辑进行判断是否有权限
        // ....
        if(无权限){
        	// 需要注意的是，拦截器返回的不会走ResultProvider。
            return new JsonBean<>(403,"无权访问");
        }
        // 放行
        return null;
    }
}

```

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

### Configure JSON Date Format with Jackson

Source: https://www.ssssssss.org/magic-api/pages/faq

Configure Jackson for date formatting and time zone in Spring Boot applications. This is the default JSON framework used by Spring Boot.

```yaml
spring:
  jackson:
    time-zone: GMT+8
    date-format: yyyy-MM-dd HH:mm:ss

```

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

### Comparison Operators and Boolean Results

Source: https://www.ssssssss.org/magic-api/pages/base/script

Illustrates the use of comparison operators (<, <=, >, >=, !=, ==) which return a boolean type.

```Magic API
var isLess = 23 < 34;
var isEqual = 23 == 34;
```

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

### Import Request Module

Source: https://www.ssssssss.org/magic-api/pages/module/request

Imports the request module for use in subsequent calls.

```python
import request;
```

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

### Retrieve Cookie Parameters in Script

Source: https://www.ssssssss.org/magic-api/pages/faq

Access cookie parameters within scripts using `cookie.xxx` notation.

```plaintext
脚本使用`cookie.xxx`获取`Cookie`中的参数 `SQL`中使用`#{cookie.xxx}`或`${cookie.xxx}`获取`Cookie`中的参数

```

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

### Retrieve Session Parameters in Script

Source: https://www.ssssssss.org/magic-api/pages/faq

Access session parameters within scripts using `session.xxx` notation.

```plaintext
脚本中使用`session.xxx`获取`Session`中的参数 `SQL`中使用`#{xxx}`或`{session.xxx}`获取`Session`中的参数

```

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

### Use Globally Imported Module

Source: https://www.ssssssss.org/magic-api/pages/senior/module

Access functions from globally imported modules directly without an explicit import statement in the script.

```script
test.println('Custom Module!'); 

```

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

### Custom LocalDateTime Serializer for Jackson

Source: https://www.ssssssss.org/magic-api/pages/faq

Provide a custom serializer for LocalDateTime to enforce a specific date-time format when using Jackson.

```java
@Bean 
public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
    LocalDateTimeSerializer localDateTimeSerializer = new LocalDateTimeSerializer(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
    return builder -> builder.serializerByType(LocalDateTime.class, localDateTimeSerializer); 
}

```

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

### getValues

Source: https://www.ssssssss.org/magic-api/pages/module/request

Fetches an array of string values submitted with the request, typically from form inputs.

```APIDOC
## getValues

### Description
Retrieves an array of string values submitted with the request.

### Parameters
#### Path Parameters
- **name** (String) - Required - The name of the parameter whose values are to be retrieved.

### Return Value
- **List<String>** - A list of string values.

### Example
```python
import request
return request.getValues('name')
```
```

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

### Optional Chaining Operator (?.) for Safe Property Access

Source: https://www.ssssssss.org/magic-api/pages/base/script

Illustrates the optional chaining operator (?.) for safely accessing nested properties or methods on objects that might be null or undefined. Returns null if the chain is broken.

```Magic API
var obj = null;
var prop = obj?.prop;
var methodCall = obj?.method();
```

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

### Expand Collection for SQL IN Clause

Source: https://www.ssssssss.org/magic-api/pages/faq

Automatically expand collection parameters for SQL `IN` clauses using `in (#{ids})` syntax. This avoids manual looping for simple cases.

```javascript
var ids = [1,2,3,4,5,6];
//会自动变成select * from sys_user where id in(?,?,?,?,?,?)
return db.select('select * from sys_user where id in(#{ids})'); 

```

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

### getHeaders

Source: https://www.ssssssss.org/magic-api/pages/module/request

Retrieves an array of string values for a specified request header.

```APIDOC
## getHeaders

### Description
Retrieves an array of string values for a specified request header.

### Parameters
#### Path Parameters
- **name** (String) - Required - The name of the header whose values are to be retrieved.

### Return Value
- **List<String>** - A list of header values.

### Example
```python
import request
return request.getHeaders('xxx')
```
```

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

### Retrieve RequestBody Parameters in Script

Source: https://www.ssssssss.org/magic-api/pages/faq

Access parameters from the request body within scripts using `body.xxx` notation.

```plaintext
脚本中使用`body.xxx`获取`RequestBody`中的参数 `SQL`中使用`#{body.xxx}`或`${body.xxx}`获取`RequestBody`中的参数

```

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

### getFile

Source: https://www.ssssssss.org/magic-api/pages/module/request

Retrieves a single uploaded file by its name. This function is useful for handling single file uploads in a request.

```APIDOC
## getFile

### Description
Retrieves a single uploaded file by its name.

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the file to retrieve.

### Return Value
- **MultipartFile** - The uploaded file.

### Example
```python
import request
request.getFile('image')
```
```

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

### Convert Number to Percentage String

Source: https://www.ssssssss.org/magic-api/pages/function/math

Converts a numerical value into a percentage string, optionally retaining a specified number of decimal places. The decimal place argument is optional and defaults to 0.

```javascript
return percent(0.1289999999,2);  // "12.90%"
```

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

### percent

Source: https://www.ssssssss.org/magic-api/pages/function/math

Converts a numerical value into a percentage string, optionally retaining a specified number of decimal places.

```APIDOC
## percent

### Description
Converts a numerical value into a percentage string. It can optionally retain a specified number of decimal places. If not specified, it defaults to 0 decimal places.

### Parameters
#### Path Parameters
- **number** (Number) - The target value to convert to a percentage.
- **len** (int) - Optional. The number of decimal places to retain in the percentage string. Defaults to 0.

### Return Value
- **String** - The formatted percentage string (e.g., "12.90%").

### Example
```javascript
return percent(0.1289999999, 2); // Returns "12.90%"
```
```

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

### Ternary Operator for Conditional Expressions

Source: https://www.ssssssss.org/magic-api/pages/base/script

Demonstrates the ternary operator as a shorthand for if-else statements. Supports non-boolean conditions in versions 0.4.3+.

```Magic API
var message = true ? "yes" : "no";
```

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

### floor

Source: https://www.ssssssss.org/magic-api/pages/function/math

Rounds a number down to the nearest whole integer.

```APIDOC
## floor

### Description
Rounds a number down to the nearest whole integer.

### Parameters
#### Path Parameters
- **number** (Number) - The target value to be rounded down.

### Return Value
- **Number** - The result of rounding down.

### Example
```javascript
return floor(123.456); // Returns 123
```
```

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

### Retrieve PathVariable Parameters in Script

Source: https://www.ssssssss.org/magic-api/pages/faq

Access path variable parameters within scripts using `PathVariableName` or `path.xxxx` notation.

```plaintext
脚本中使用`PathVariableName`或`path.xxxx`获取`PathVariable`中的参数 `SQL`中使用`#{PathVariableName}`或`#{path.xxx}`获取`PathVariable`中的参数

```

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

### Round a Number to a Specific Decimal Place

Source: https://www.ssssssss.org/magic-api/pages/function/math

Rounds a number to a specified number of decimal places using standard rounding rules. The decimal place argument is optional and defaults to 0.

```javascript
return round(123.456d,2);  //123.46
```

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

### ceil

Source: https://www.ssssssss.org/magic-api/pages/function/math

Rounds a number up to the nearest whole integer.

```APIDOC
## ceil

### Description
Rounds a number up to the nearest whole integer.

### Parameters
#### Path Parameters
- **number** (Number) - The target value to be rounded up.

### Return Value
- **Number** - The result of rounding up.

### Example
```javascript
return ceil(123.456); // Returns 124
```
```

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

### round

Source: https://www.ssssssss.org/magic-api/pages/function/math

Rounds a number to a specified number of decimal places using standard rounding rules.

```APIDOC
## round

### Description
Rounds a number to a specified number of decimal places. If the number of decimal places is not provided, it defaults to 0.

### Parameters
#### Path Parameters
- **number** (Number) - The target value to be rounded.
- **len** (int) - Optional. The number of decimal places to retain. Defaults to 0.

### Return Value
- **Number** - The rounded number.

### Example
```javascript
return round(123.456, 2); // Returns 123.46
```
```

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

### Floor a Number

Source: https://www.ssssssss.org/magic-api/pages/function/math

Rounds a number down to the nearest whole integer. This function is useful for obtaining the largest integer less than or equal to the given number.

```javascript
return floor(123.456d);  // 123;
```

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

### Ceil a Number

Source: https://www.ssssssss.org/magic-api/pages/function/math

Rounds a number up to the nearest whole integer. This function is useful for obtaining the smallest integer greater than or equal to the given number.

```javascript
return ceil(123.456d);  // 124;
```
Tokens:
Raw