APIJSON

https://github.com/tencent/apijson
Admin
🏆 实时零代码、全功能、强安全 ORM 库 🚀 后端接口和文档零代码，前端(客户端) 定制返回 JSON 的数据和结构 🏆 Real-Time coding-free, powerful...
Tokens:22,456
Snippets:251
Trust Score:9.5
License:Apache-2.0
Update:2 months ago
Show doc for...
Tokens:
Raw
### Get a User

Source: https://github.com/tencent/apijson/blob/master/Document.md

This example demonstrates how to retrieve a single user object. It shows the request format and the expected JSON response.

```APIDOC
## GET /get/{"User":{}}

### Description
Retrieves a single user object from the system.

### Method
GET

### Endpoint
/get/{"User":{}}

### Request Body
```json
{
  "User":{
  }
}
```

### Response
#### Success Response (200)
- **User** (object) - Contains user details like id, sex, name, certified, tag, phone, head, date, and pictureList.
- **code** (integer) - The status code of the response.
- **msg** (string) - A message indicating the success or failure of the request.

#### Response Example
```json
{
  "User":{
    "id":38710,
    "sex":0,
    "name":"TommyLemon",
    "certified":true,
    "tag":"Android&Java",
    "phone":13000038710,
    "head":"http://static.oschina.net/uploads/user/1218/2437072_100.jpg?t=1461076033000",
    "date":1485948110000,
    "pictureList":[
      "http://static.oschina.net/uploads/user/1218/2437072_100.jpg?t=1461076033000",
      "http://common.cnblogs.com/images/icon_weibo_24.png"
    ]
  },
  "code":200,
  "msg":"success"
}
```
```

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

### Get a Moment and its publisher

Source: https://github.com/tencent/apijson/blob/master/Document.md

This example illustrates fetching a 'Moment' object and its associated 'User' (publisher) by linking 'User.id' to 'Moment.userId'.

```APIDOC
## GET /get/{"Moment":{},"User":{"id@":"Moment/userId"}}

### Description
Retrieves a 'Moment' object and its corresponding publisher ('User') by joining on the 'userId' field.

### Method
GET

### Endpoint
/get/{"Moment":{},"User":{"id@":"Moment/userId"}}

### Request Body
```json
{
  "Moment":{},
  "User":{
    "id@":"Moment/userId"
  }
}
```

### Response
#### Success Response (200)
- **Moment** (object) - Contains details of the moment, such as id, userId, date, and content.
- **User** (object) - Contains details of the user who published the moment, including id, sex, name, tag, head, contactIdList, and date.
- **code** (integer) - The status code of the response.
- **msg** (string) - A message indicating the success or failure of the request.

#### Response Example
```json
{
  "Moment":{
    "id":12,
    "userId":70793,
    "date":"2017-02-08 16:06:11.0",
    "content":"1111534034"
  },
  "User":{
    "id":70793,
    "sex":0,
    "name":"Strong",
    "tag":"djdj",
    "head":"http://static.oschina.net/uploads/user/585/1170143_50.jpg?t=1390226446000",
    "contactIdList":[
      38710,
      82002
    ],
    "date":"2017-02-01 19:21:50.0"
  },
  "code":200,
  "msg":"success"
}
```
```

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

### Complete Commit Example

Source: https://github.com/tencent/apijson/blob/master/CONTRIBUTING_COMMIT.md

A comprehensive example demonstrating the use of 'feat' type, a detailed body with bullet points, and issue association.

```markdown
feat: 添加了分享功能

给每篇文章添加了分享功能

- 添加分享到微信功能
- 添加分享到朋友圈功能

issue #1, #2
closes #1
```

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

### Get an array of Users

Source: https://github.com/tencent/apijson/blob/master/Document.md

This example shows how to retrieve a limited array of user objects, specifying which columns to include. It details the request and response structures.

```APIDOC
## GET /get/{"[]":{"count":3,"User":{"@column":"id,name"}}}

### Description
Retrieves a specified number of user objects, fetching only the 'id' and 'name' fields.

### Method
GET

### Endpoint
/get/{"[]":{"count":3,"User":{"@column":"id,name"}}}

### Parameters
#### Query Parameters
- **count** (integer) - Optional - Specifies the maximum number of results to return.
- **@column** (string) - Optional - A comma-separated list of fields to include in the response.

### Request Body
```json
{
  "[]":{
    "count":3, 
    "User":{
      "@column":"id,name"
    }
  }
}
```

### Response
#### Success Response (200)
- **[]** (array) - An array of user objects, each containing 'id' and 'name'.
- **code** (integer) - The status code of the response.
- **msg** (string) - A message indicating the success or failure of the request.

#### Response Example
```json
{
  "[]":[
    {
      "User":{
        "id":38710,
        "name":"TommyLemon"
      }
    },
    {
      "User":{
        "id":70793,
        "name":"Strong"
      }
    },
    {
      "User":{
        "id":82001,
        "name":"Android"
      }
    }
  ],
  "code":200,
  "msg":"success"
}
```
```

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

### APIJSON Self-Defined Keyword Example

Source: https://github.com/tencent/apijson/blob/master/Document.md

Shows how to use self-defined keywords, such as 'name@' in this example, to add custom fields to the response. This allows for flexible data structuring and inclusion of application-specific information.

```JSON
{"User":{},
"[]":{
 "name@":"User/name", 
 "Moment":{}
}}
```

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

### Enable Query Profiling

Source: https://github.com/tencent/apijson/blob/master/Document.md

Enables query profiling for the 'Moment' table. Set '@explain' to true to get detailed performance information about the query.

```json
["@explain":true]

```

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

### Getting Data in a Range with '%'

Source: https://github.com/tencent/apijson/blob/master/Document.md

Retrieve data within a specified range using the '%' keyword followed by 'start,end'. This is applicable to Boolean, Number, or String data types and functions like SQL's BETWEEN.

```JSON
"date%":"2017-10-01,2018-10-01"
```

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

### GETS Method

Source: https://github.com/tencent/apijson/blob/master/Document.md

Used to get data with high security and confidentiality, such as bank accounts or birth dates. Requires a 'tag' parameter.

```APIDOC
## GETS /gets/

### Description
Get data with high security and confidentiality. Eg. bank accounts, birth date.

### Method
GET

### Endpoint
base_url/gets/

### Request Body
Requires adding `"tag":tag` with the same level as the table name. Other conditions are the same as **GET**.

### Response
Same as **GET**.
```

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

### Closing Issue Example

Source: https://github.com/tencent/apijson/blob/master/CONTRIBUTING_COMMIT.md

When committing to the default branch, use keywords like 'closes' followed by the issue number to automatically close the issue.

```markdown
closes #1
```

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

### Get a Moment and its Publisher

Source: https://github.com/tencent/apijson/blob/master/Document.md

Retrieve a 'Moment' object and its associated 'User' publisher by linking 'User.id' to 'Moment.userId'.

```json
{
  "Moment":{
  },
  "User":{
    "id@":"Moment/userId"
  }
}
```

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

### GET Method

Source: https://github.com/tencent/apijson/blob/master/Document.md

Used to retrieve data. Supports filtering and conditions within the request body.

```APIDOC
## GET /get/

### Description
A general way to get data. You can use dev tools to make edits in a web browser.

### Method
GET

### Endpoint
base_url/get/

### Request Body
```json
{
  "TableName":{
    //Add conditions here.
  }
}
```

**Example:** To get a Moment with `id = 235`:
```json
{
  "Moment":{
    "id":235
  }
}
```

### Response
#### Success Response (200)
```json
{
  "TableName":{
    "...": "..."
  },
  "code":200,
  "msg":"success"
}
```

**Example:**
```json
{
  "Moment":{
    "id":235,
    "userId":38710,
    "content":"APIJSON is the real-time coding-free, powerful and secure ORM"
  },
  "code":200,
  "msg":"success"
}
```
```

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

### Get Data in a Range

Source: https://github.com/tencent/apijson/blob/master/Document.md

Retrieve data within a specified range using the `"key%":["start,end"]` format, applicable to Boolean, Number, or String types.

```APIDOC
## Get Data in a Range

### Description
Retrieve data within a specified range using the format `"key%":["start,end"]`. This is applicable to Boolean, Number, or String types and is useful for date or numerical ranges.

### Example
```json
{
  "User[]": {
    "count": 3,
    "User": {
      "date%": "2017-01-01,2018-01-01"
    }
  }
}
```
This example retrieves user data registered between '2017-01-01' and '2018-01-01'.

### URL Example
`http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"date%2525":"2017-01-01,2018-01-01"}}}`

### SQL Equivalent
`date BETWEEN '2017-01-01' AND '2018-01-01'`
```

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

### Commit Body Example

Source: https://github.com/tencent/apijson/blob/master/CONTRIBUTING_COMMIT.md

The Body provides a detailed explanation of the commit. It can span multiple lines and use bullet points for clarity. Explain the motivation for the change and contrast it with previous behavior.

```markdown
More detailed explanatory text, if necessary.  Wrap it to 
about 72 characters or so. 

Further paragraphs come after blank lines.

- Bullet points are okay, too
- Use a hanging indent
```

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

### Check Private Information with APIJSON

Source: https://github.com/tencent/apijson/blob/master/Document.md

Use the 'tag' keyword to specify the data structure to query. This example demonstrates fetching privacy information.

```json
{
  "tag": "Privacy",
  "Privacy": {
    "id": 82001
  }
}
```

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

### HEADS Method

Source: https://github.com/tencent/apijson/blob/master/Document.md

Used to get counts of confidential data, like bank accounts. Requires a 'tag' parameter.

```APIDOC
## HEADS /heads/

### Description
Get counts of confidential data (eg. bank account).

### Method
HEAD

### Endpoint
base_url/heads/

### Request Body
Requires adding `"tag":tag` with the same level as the table name. Other conditions are the same as **HEAD**.

### Response
Same as **HEAD**.
```

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

### HEAD Method

Source: https://github.com/tencent/apijson/blob/master/Document.md

Used to get counts of data. Supports filtering and conditions within the request body.

```APIDOC
## HEAD /head/

### Description
A general way to get counts. You can use dev tools to make edits in a web browser.

### Method
HEAD

### Endpoint
base_url/head/

### Request Body
```json
{
  "TableName":{
    // ... conditions ...
  }
}
```

**Example:** Get the number of Moments posted by the user with `id = 38710`:
```json
{
  "Moment":{
    "userId":38710
  }
}
```

### Response
#### Success Response (200)
```json
{
  "TableName":{
    "code":200,
    "msg":"success",
    "count":10
  },
  "code":200,
  "msg":"success"
}
```

**Example:**
```json
{
  "Moment":{
    "code":200,
    "msg":"success",
    "count":10
  },
  "code":200,
  "msg":"success"
}
```
```

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

### Get a Single User Object

Source: https://github.com/tencent/apijson/blob/master/Document.md

Use this snippet to retrieve a single user object. The response includes all user details.

```json
{
  "User":{
  }
}
```

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

### Issue Association Example

Source: https://github.com/tencent/apijson/blob/master/CONTRIBUTING_COMMIT.md

Associate a commit with an issue by referencing its number in the Footer.

```markdown
issue #2
```

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

### Get an Array of Users with Specific Columns

Source: https://github.com/tencent/apijson/blob/master/Document.md

Retrieve a limited number of user records, fetching only the 'id' and 'name' columns. The 'count' parameter limits the results.

```json
{
  "[]":{
    "count":3, 
    "User":{
      "@column":"id,name"
    }
  }
}
```

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

### Get Data in Arrays using APIJSON

Source: https://github.com/tencent/apijson/blob/master/Document.md

Use the 'key[]' syntax to retrieve data as an array. The part after the colon is a JSONObject. 'key' is optional; if it matches the table name, the JSONObject can be simplified.

```json
{"User[]":{"count":3,"User":{}}}
```

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

### Format Moments Interface Response with APIJSON

Source: https://github.com/tencent/apijson/blob/master/Document.md

Utilize the 'format' keyword to control the casing of keys in the JSON response. This example formats the 'Moments' interface response to camelCase.

```json
{
  "format": true,
  "[]": {
    "page": 0,
    "count": 3,
    "Moment": {},
    "User": {
      "id@": "/Moment/userId"
    },
    "Comment[]": {
      "count": 3,
      "Comment": {
        "momentId@": "[]/Moment/id"
      }
    }
  }
}
```

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

### Check Private Information using Version 1 APIJSON

Source: https://github.com/tencent/apijson/blob/master/Document.md

Specify the 'version' keyword to use a particular API version. This example fetches privacy information using version 1.

```json
{
  "version": 1,
  "tag": "Privacy",
  "Privacy": {
    "id": 82001
  }
}
```

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

### APIJSON Response for Delete Operation

Source: https://github.com/tencent/apijson/blob/master/Document.md

This is an example of a successful response after a delete operation, indicating the status and affected IDs.

```json
{
  "TableName":{
    "code":200,
    "msg":"success",
    "id[]":[100,110,120],
    "count":3
  },
  "code":200,
  "msg":"success"
}
```

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

### Group and Filter Moments with Custom Function Name

Source: https://github.com/tencent/apijson/blob/master/Document.md

Similar to the previous example, but renames the aggregated 'max(id)' column to 'maxId' for clarity in the results.

```json
["@column":"userId;max(id):maxId",
"@group":"userId",
"@having":"(maxId)>=100"]

```

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

### GET Request for Data

Source: https://github.com/tencent/apijson/blob/master/Document.md

Use this method to retrieve data. You can specify conditions within the JSON payload. The response includes the requested data along with a status code and message.

```json
{
  "TableName":{
    //Add contiditions here.
  }
}

Eg. To get a Moment with `id = 235`：
{
  "Moment":{
    "id":235
  }
}
```

```json
{
  "TableName":{
    ...
  },
  "code":200,
  "msg":"success"
}
Eg.
{
  "Moment":{
    "id":235,
    "userId":38710,
    "content":"APIJSON is the real-time coding-free, powerful and secure ORM"
  },
  "code":200,
  "msg":"success"
 }
```

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

### Get Moment List with User and Comment Data

Source: https://github.com/tencent/apijson/blob/master/Document.md

This snippet shows how to retrieve a list of Moments, similar to Twitter tweets, along with associated User and Comment data. It includes pagination, content filtering, and referencing fields from related objects.

```json
{
  "[]":{
    "page":0,
    "count":2,
    "Moment":{
      "content$":"%a%"
    },
    "User":{
      "id@":"/Moment/userId",
      "@column":"id,name,head"
    },
    "Comment[]":{
      "count":2,
      "Comment":{
        "momentId@":"[]/Moment/id"
      }
    }
  }
}
```

```json
{
  "[]":[
    {
      "Moment":{
        "id":15,
        "userId":70793,
        "date":1486541171000,
        "content":"APIJSON is a JSON Transmission Protocol…",
        "praiseUserIdList":[
          82055,
          82002,
          82001
        ],
        "pictureList":[
          "http://static.oschina.net/uploads/user/1218/2437072_100.jpg?t=1461076033000",
          "http://common.cnblogs.com/images/icon_weibo_24.png"
        ]
      },
      "User":{
        "id":70793,
        "name":"Strong",
        "head":"http://static.oschina.net/uploads/user/585/1170143_50.jpg?t=1390226446000"
      },
      "Comment[]":[
        {
          "id":176,
          "toId":166,
          "userId":38710,
          "momentId":15,
          "date":1490444883000,
          "content":"thank you"
        },
        {
          "id":1490863469638,
          "toId":0,
          "userId":82002,
          "momentId":15,
          "date":1490863469000,
          "content":"Just do it"
        }
      ]
    },
    {
      "Moment":{
        "id":58,
        "userId":90814,
        "date":1485947671000,
        "content":"This is a Content...-435",
        "praiseUserIdList":[
          38710,
          82003,
          82005,
          93793,
          82006,
          82044,
          82001
        ],
        "pictureList":[
          "http://static.oschina.net/uploads/img/201604/22172507_aMmH.jpg"
        ]
      },
      "User":{
        "id":90814,
        "name":7,
        "head":"http://static.oschina.net/uploads/user/51/102723_50.jpg?t=1449212504000"
      },
      "Comment[]":[
        {
          "id":13,
          "toId":0,
          "userId":82005,
          "momentId":58,
          "date":1485948050000,
          "content":"This is a Content...-13"
        },
        {
          "id":77,
          "toId":13,
          "userId":93793,
          "momentId":58,
          "date":1485948050000,
          "content":"This is a Content...-77"
        }
      ]
    }
  ],
  "code":200,
  "msg":"success"
}
```

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

### HEAD Request for Counts

Source: https://github.com/tencent/apijson/blob/master/Document.md

Use this method to get the count of data entries matching specific conditions. The response includes the count along with a status code and message.

```json
{
  "TableName":{
    …
  }
}
{…} are conditions. 

Eg. Get the number of Moments posted by the user with `id = 38710`：
{
  "Moment":{
    "userId":38710
  }
}
```

```json
{
  "TableName":{
    "code":200,
    "msg":"success",
    "count":10
  },
  "code":200,
  "msg":"success"
} 
Eg.
{
  "Moment":{
    "code":200,
    "msg":"success",
    "count":10
  },
  "code":200,
  "msg":"success"
}
```

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

### APIJSON ORM Content Validation Configuration

Source: https://github.com/tencent/apijson/wiki/Home

Configure content validation rules within the database configuration. This example shows how to validate the 'type' field to accept only specific integer values.

```json
"VERIFY":{
  "type{}":[0,1,2]
}
```

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

### Add JitPack Repository for Gradle

Source: https://github.com/tencent/apijson/blob/master/APIJSONORM/README.md

Append this to the repositories block in your root build.gradle file for Gradle projects.

```gradle
	allprojects {
		repositories {
			...
			maven { url 'https://jitpack.io' }
		}
	}
```

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

### SQL Transformation with WITH Clause

Source: https://github.com/tencent/apijson/blob/master/Roadmap.md

Demonstrates the transformation of standard SQL queries into a format utilizing a WITH clause for improved readability and performance. This applies to both Moment and Comment tables.

```sql
WITH (SELECT `id` FROM `sys`.`User` WHERE `id` IN($contactIdList)) AS `sql`
SELECT * FROM `sys`.`Moment` WHERE ( (`userId` IN `sql` ) ) ORDER BY `date` DESC LIMIT 10 OFFSET 0
```

```sql
WITH (SELECT `id` FROM `sys`.`User` WHERE `id` IN($contactIdList)) AS `sql`
SELECT * FROM `sys`.`Comment` WHERE ( (`userId` IN `sql` ) ) ORDER BY `date` DESC LIMIT 10 OFFSET 0
```

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

### GETS Request for Confidential Data

Source: https://github.com/tencent/apijson/blob/master/Document.md

This method retrieves confidential data with high security. It requires an additional 'tag' parameter in the request payload, similar to other GET requests.

```json
You need to add "tag":tag with the same level of `Moment:{}`. Others are the same as **GET**.
```

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

### Map Stone Class to b_stone Table

Source: https://github.com/tencent/apijson/blob/master/详细的说明文档.md

Configuration within DemoSQLConfig to map the 'Stone' Java class to the 'b_stone' database table. This is necessary when the class and table names do not match.

```Java
//表名映射，隐藏真实表名，对安全要求很高的表可以这么做
	static {
		TABLE_KEY_MAP.put(User.class.getSimpleName(), "apijson_user");
		TABLE_KEY_MAP.put(Privacy.class.getSimpleName(), "apijson_privacy");
		TABLE_KEY_MAP.put(Stone.class.getSimpleName(), "b_stone"); // <--这一句
	}
```

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

### Support for Distributed Systems with @url

Source: https://github.com/tencent/apijson/blob/master/Roadmap.md

Enables forwarding requests to other servers for execution. A '~' prefix can be used to indicate asynchronous execution.

```JSON
{
    "User": {
        "@url": "http://apijson.cn:8080/get"  //转发给其它服务器执行
    },
    "[]": {
        "Comment": {
            "userId@": "User/id"
        }
    },
    "@explain": true
}
```

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

### 使用 '~' 进行模糊查询

Source: https://github.com/tencent/apijson/blob/master/详细的说明文档.md

使用 `content~` 语法代替 `content$:'%keyword%'` 来表示包含某字符串，提高查询便捷性。

```JSON
{
  "[]": {
      "Moment":{
        "content~":"keyword",
        "@column":"id,date,content:text"
      }
  }
}
```

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

### Add JitPack Repository for Maven

Source: https://github.com/tencent/apijson/blob/master/APIJSONORM/README.md

Include this repository in your pom.xml to allow Maven to fetch dependencies from JitPack.

```xml
	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>
```

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

### Subquery

Source: https://github.com/tencent/apijson/blob/master/Document.md

Perform subqueries using the `"key@":{"range":"ALL/ANY","from":"Table","Table":{...}}` structure, similar to SQL subqueries.

```APIDOC
## Subquery

### Description
Perform subqueries using the `"key@":{"range":"ALL/ANY","from":"Table","Table":{...}}` structure. This allows for complex queries similar to SQL subqueries.

### Example
```json
{
  "User": {
    "id@": {
      "from": "Comment",
      "Comment": {
        "@column": "min(userId)"
      }
    }
  }
}
```
This example retrieves the minimum `userId` from the `Comment` table and assigns it to the `User.id`.

### URL Example
`http://apijson.cn:8080/get/{"User":{"id@":{"from":"Comment","Comment":{"@column":"min(userId)"}}}}`

### SQL Equivalent
`WHERE id=(SELECT min(userId) FROM Comment)`
```

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

### 使用正则表达式匹配数据

Source: https://github.com/tencent/apijson/blob/master/详细的说明文档.md

使用 `content~` 语法配合正则表达式 `^[0-9]+$` 查询 `content` 列为纯数字的数据，并指定返回 `id,date,content` 列。

```JSON
{
  "[]": {
      "Moment":{
        "content~":"^[0-9]+$",
        "@column":"id,date,content:text"
      }
  }
}
```

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

### Fuzzy Matching with '$'

Source: https://github.com/tencent/apijson/blob/master/Document.md

Implement fuzzy matching using the '$' keyword followed by SQL search expressions. This allows for flexible searching based on patterns like '%key%' or 'key%'.

```JSON
"name$":"%m%"
```

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

### APIJSON Response Example for Comment Deletion

Source: https://github.com/tencent/apijson/blob/master/Document.md

This JSON structure represents a typical response after deleting comments, showing success status and details.

```json
{
  "Comment":{
    "code":200,
    "msg":"success",
    "id[]":[100,110,120],
    "count":3
  },
  "code":200,
  "msg":"success"
}
```

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

### POST Method

Source: https://github.com/tencent/apijson/blob/master/Document.md

Used to add new data. The 'id' is generated automatically. Requires a 'tag' parameter.

```APIDOC
## POST /post/

### Description
Add new data.

### Method
POST

### Endpoint
base_url/post/

### Request Body
```json
{
  "TableName":{
    // ... fields ...
  },
  "tag":tag
}
```
The id in `{}` is generated automatically when the table is built and can’t be set by the user.

**Example:** A user with `id = 38710` posts a new Moment:
```json
{
  "Moment":{
    "userId":38710,
    "content":"APIJSON is the real-time coding-free, powerful and secure ORM"
  },
  "tag":"Moment"
}
```

### Response
#### Success Response (200)
```json
{
  "TableName":{
    "code":200,
    "msg":"success",
    "id":38710
  },
  "code":200,
  "msg":"success"
}
```

**Example:**
```json
{
  "Moment":{
    "code":200,
    "msg":"success",
    "id":120
  },
  "code":200,
  "msg":"success"
}
```
```

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

### Get Element from Array by Position

Source: https://github.com/tencent/apijson/blob/master/Document.md

Retrieves the first element from the 'pictureList' array using a self-defined '@position' keyword and a custom function 'getFromArray'.

```json
["@position":0, //self-defined keyword
"firstPicture()":"getFromArray(pictureList,@position)"]

```

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

### Specify Database for Table Access

Source: https://github.com/tencent/apijson/blob/master/Document.md

Queries the 'User' table from the 'POSTGRESQL' database. Use this to connect to different database systems.

```json
["@database":"POSTGRESQL"]

```

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

### 过滤包含特定 ID 的列表数据

Source: https://github.com/tencent/apijson/blob/master/详细的说明文档.md

使用 `praiseUserIdList<>` 语法过滤出 `praiseUserIdList` 数组中包含 `82001` 的数据，并指定返回 `id,date,content,praiseUserIdList` 列。

```JSON
{
  "[]": {
      "Moment":{
        "praiseUserIdList<>":82001,
        "@column":"id,date,content,praiseUserIdList"
      }
  }
}
```

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

### 模糊查询包含特定字符串的数据

Source: https://github.com/tencent/apijson/blob/master/详细的说明文档.md

使用 `content$` 语法进行模糊查询，筛选出 `content` 列包含 `%APIJSON%` 的数据，并指定返回 `id,date,content` 列。

```JSON
{
  "[]": {
      "Moment":{
        "content$":"%APIJSON%",
        "@column":"id,date,content:text"
      }
  }
}
```

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

### Get Data with Specific IDs using APIJSON

Source: https://github.com/tencent/apijson/blob/master/Document.md

Retrieve data where the 'id' field matches any of the IDs provided in the array. This is equivalent to an SQL 'IN' clause.

```json
{"User[]":{"count":3,"User":{"id{}":[38710,82001,70793]}}}
```

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

### Get Data Containing an Element using APIJSON

Source: https://github.com/tencent/apijson/blob/master/Document.md

Find data where a JSON array field contains a specific element. The 'key<>' syntax is used for this containment check.

```json
{"User[]":{"count":3,"User":{"contactIdList<>":38710}}}
```

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

### HEADS Request for Confidential Counts

Source: https://github.com/tencent/apijson/blob/master/Document.md

Use this method to get counts of confidential data. It requires an additional 'tag' parameter in the request payload, similar to other HEAD requests.

```json
You need to add  "tag":tag with the same level of `Moment:{}`. Others are the same as **HEAD**.
```

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

### Add APIJSON Dependency for Gradle

Source: https://github.com/tencent/apijson/blob/master/APIJSONORM/README.md

Add this implementation dependency to your module's build.gradle file (e.g., app/build.gradle).

```gradle
	dependencies {
	        implementation 'com.github.Tencent:APIJSON:8.1.8'
	}
```

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

### Fuzzy Matching

Source: https://github.com/tencent/apijson/blob/master/Document.md

Implement fuzzy matching using SQL search expressions with the `"key$":["SQL search expressions"]` format.

```APIDOC
## Fuzzy Matching

### Description
Implement fuzzy matching using SQL search expressions with the format `"key$":["SQL search expressions"]`. Supports wildcards like `%` for flexible searching.

### Example
```json
{
  "User[]": {
    "count": 3,
    "User": {
      "name$": "%m%"
    }
  }
}
```
This example searches for users whose names contain 'm'.

### URL Example
`http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"name$":"%2525m%2525"}}}`

### SQL Equivalent
`name LIKE '%m%'`
```

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

### 组合多个条件进行数据筛选

Source: https://github.com/tencent/apijson/blob/master/详细的说明文档.md

组合使用 `id&{}` 和 `id!{}` 来筛选出 id 在 10 到 40 之间但不包含 12 的数据，并指定返回 `id,date,content` 列。

```JSON
{
  "[]": {
      "Moment":{
        "id&{}":">=10,<=40",
        "id!{}":[12],
        "@column":"id,date,content:text"
      }
  }
}
```

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

### Function Calls in Parameters

Source: https://github.com/tencent/apijson/blob/master/Document.md

Trigger backend functions by including them in URL parameters. The format `"key()":"function(key0,key1...)"` allows for dynamic data retrieval or testing.

```APIDOC
## Function Calls in Parameters

### Description
Include functions in parameters to trigger backend processing. The format `"key()":"function(key0,key1...)"` allows the backend to execute a function with specified keys.

### Example
```json
["isPraised()":"isContain(praiseUserIdList,userId)"]
```
This example uses the `isPraised()` function to check if a user has praised a moment, utilizing the `isContain` function with `praiseUserIdList` and `userId`.

### URL Example
`http://apijson.cn:8080/get/{"Moment":{"id":301,"isPraised()":"isContain(praiseUserIdList,userId)"}}`

### Response
Returns a boolean indicating whether the condition is met (e.g., `"isPraised":true`).
```

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

### Using Functions in URL Parameters

Source: https://github.com/tencent/apijson/blob/master/Document.md

Trigger backend functions for data retrieval or verification by including functions in parameters. The backend function signature is `function(JSONObject request, String key0, String key1...)`.

```JSON
"key()":"function (key0,key1...)"
```

```JSON
"isPraised()":"isContain(praiseUserIdList,userId)"
```

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

### Create b_stone Table

Source: https://github.com/tencent/apijson/blob/master/详细的说明文档.md

SQL statement to create a new table named 'b_stone' in the database. This table is intended for storing stone-related data.

```SQL
-- 原石
CREATE TABLE `b_stone` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT,
  `cost` int(10) NULL COMMENT '成本',
  `price` int(10) NULL COMMENT '卖价',
  `length` int(10) NULL,
  `width`  int(10) NULL,
  `height` int(10) NULL,
  `weight` float(8,1) NULL,
  `creationdate` datetime default CURRENT_TIMESTAMP COMMENT '创建时间',
  `modifydate` timestamp DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间',
  `modifier` varchar(80) NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
```

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

### Get Data with Comparison Operations using APIJSON

Source: https://github.com/tencent/apijson/blob/master/Document.md

Filter data based on comparison operations like '<=', '>'. Use single quotes for non-numeric characters. This supports SQL-like 'OR' conditions for the same field.

```json
{"User[]":{"count":3,"User":{"id{}":"<=80000,>90000"}}}
```

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

### Get Moment List

Source: https://github.com/tencent/apijson/blob/master/Document.md

Retrieves a list of moments, allowing filtering by content, selecting specific user fields, and fetching associated comments. This operation is analogous to fetching tweets with their associated data.

```APIDOC
## GET /get

### Description
Retrieves a list of moments, similar to Twitter tweets, with options for pagination, content filtering, and fetching associated user and comment data.

### Method
GET

### Endpoint
/get

### Parameters
#### Query Parameters
- **`[]`** (object) - Required - The main query object defining the structure of the data to retrieve.
  - **`page`** (integer) - Optional - Pagination parameter to specify the page number.
  - **`count`** (integer) - Optional - Pagination parameter to specify the number of items per page.
  - **`Moment`** (object) - Optional - Defines the structure and filters for the Moment object.
    - **`content$சிரியர்`** (string) - Optional - Filters moments where the content contains the specified string (e.g., '%a%').
  - **`User`** (object) - Optional - Defines the structure and retrieval of associated User data.
    - **`id@`** (string) - Optional - Specifies a reference path to link User.id to Moment.userId (e.g., '/Moment/userId').
    - **`@column`** (string) - Optional - Specifies which columns/fields of the User object to retrieve, in a specific order (e.g., 'id,name,head').
  - **`Comment[]`** (object) - Optional - Defines the structure and retrieval of associated Comment array.
    - **`count`** (integer) - Optional - Specifies the number of comments to retrieve per moment.
    - **`Comment`** (object) - Optional - Defines the structure and filters for the Comment object within the array.
      - **`momentId@`** (string) - Optional - Specifies a reference path to link Comment.momentId to the current Moment's id (e.g., '[]/Moment/id').

### Request Example
```json
{
  "[]":{
    "page":0,
    "count":2,
    "Moment":{
      "content$சிரியர்":"%a%"
    },
    "User":{
      "id@":"/Moment/userId",
      "@column":"id,name,head"
    },
    "Comment[]":{
      "count":2,
      "Comment":{
        "momentId@":"[]/Moment/id"
      }
    }
  }
}
```

### Response
#### Success Response (200)
- **`[]`** (array) - An array of moment objects, each potentially containing associated User and Comment data.
  - **`Moment`** (object) - Details of the moment.
  - **`User`** (object) - Details of the user who posted the moment.
  - **`Comment[]`** (array) - An array of comments associated with the moment.
- **`code`** (integer) - The HTTP status code, typically 200 for success.
- **`msg`** (string) - A success message, typically 'success'.

#### Response Example
```json
{
  "[]":[
    {
      "Moment":{
        "id":15,
        "userId":70793,
        "date":1486541171000,
        "content":"APIJSON is a JSON Transmission Protocol…",
        "praiseUserIdList":[
          82055,
          82002,
          82001
        ],
        "pictureList":[
          "http://static.oschina.net/uploads/user/1218/2437072_100.jpg?t=1461076033000",
          "http://common.cnblogs.com/images/icon_weibo_24.png"
        ]
      },
      "User":{
        "id":70793,
        "name":"Strong",
        "head":"http://static.oschina.net/uploads/user/585/1170143_50.jpg?t=1390226446000"
      },
      "Comment[]":[
        {
          "id":176,
          "toId":166,
          "userId":38710,
          "momentId":15,
          "date":1490444883000,
          "content":"thank you"
        },
        {
          "id":1490863469638,
          "toId":0,
          "userId":82002,
          "momentId":15,
          "date":1490863469000,
          "content":"Just do it"
        }
      ]
    }
  ],
  "code":200,
  "msg":"success"
}
```
```

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

### APIJSON Array Keywords for Data Retrieval

Source: https://github.com/tencent/apijson/blob/master/Document.md

Explains array keywords like 'count', 'page', and 'query' for controlling data retrieval. 'count' limits the number of items, 'page' specifies the page number, and 'query' determines whether to retrieve items, total count, or both. 'total@' can be used to reference the total count.

```JSON
{"[]":{"count":5,"User":{}}}
```

```JSON
{"[]":{"count":5,
"page":3,
"User":{}}}
```

```JSON
{"[]":{
 "query":2,
 "User":{}
},
"total@":"/[]/total"}
```

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

### APIJSON Request Structure Validation - Operators

Source: https://github.com/tencent/apijson/blob/master/详细的说明文档.md

Examples of various validation operators for the 'structure' field, including range checks, type validation, uniqueness, required fields, disallowed fields, and automatic insertion/update rules.

```JSON
"VERIFY": { "money&{}":">0,<=10000" }              //自动验证是否 money>0 & money<=10000
"TYPE": { "balance": "DECIMAL" }                    //自动验证 balance 类型是否为 DECIMAL（对应 Double 双精度浮点数）
"UNIQUE": "phone"                                  //强制 phone 的值为数据库中没有的
"NECESSARY": "id,name"                             //强制传 id,name 两个字段
"DISALLOW": "balance"                              //禁止传 balance 字段
"INSERT": { "@role": "OWNER" }                     //如果没传 @role 就自动添加
"UPDATE": { "id@": "User/id" }                     //强制放入键值对
```

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

### Referencing Values with '@'

Source: https://github.com/tencent/apijson/blob/master/Document.md

Use the '@' symbol to reference values from other keys, specifying the path with '/'. This allows one key's value to be dynamically set based on another's.

```JSON
"id@":"/Moment/userId"
```

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

### Check for Existence of Data using APIJSON

Source: https://github.com/tencent/apijson/blob/master/Document.md

Use the 'key}{@' syntax to check if data exists based on subquery conditions. 'from' specifies the table to query, and the subsequent object defines the filter criteria.

```json
{"User":{"id}{@":{"from":"Comment","Comment":{"momentId":15}}}}
```

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

### Regular Expression Matching

Source: https://github.com/tencent/apijson/blob/master/Document.md

Use regular expressions for advanced searching with the `"key~":["regular expression"]` format.

```APIDOC
## Regular Expression Matching

### Description
Use regular expressions for advanced searching with the format `"key~":["regular expression"]`. This allows for pattern matching beyond simple string comparisons.

### Example
```json
{
  "User[]": {
    "count": 3,
    "User": {
      "name~": "^[0-9]+$"
    }
  }
}
```
This example searches for users whose names consist only of digits.

### URL Example
`http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"name~":"^[0-9]%252B$"}}}

### SQL Equivalent
`name REGEXP '^[0-9]+$'`
```

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

### 筛选 ID 在指定范围内的多条数据

Source: https://github.com/tencent/apijson/blob/master/详细的说明文档.md

使用 `id{}` 语法筛选出 id 在 `12,15,32` 中的数据，并指定返回 `id,date,content` 列。

```JSON
{
  "[]": {
      "Moment":{
        "id{}":[12,15,32],
        "@column":"id,date,content"
      }
  }
}
```

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

### Generate SQL WITH Clause for Performance

Source: https://github.com/tencent/apijson/blob/master/Roadmap.md

Use the 'with: true' configuration to generate SQL WITH clauses, which can reduce subquery execution and improve performance. This is useful for querying recent activities of followed users.

```json
{
    "sql@": {
        "with": true,
        "from": "User",
        "User": {
            "@column": "id",
            "@role": "CONTACT"
        }
    },
    "Moment[]": {
        "Moment": {
            "userId{}@": "sql",
            "@order": "date-"
        }
    },
    "Comment[]": {
        "Comment": {
            "userId{}@": "sql",
            "@order": "date-"
        }
    },
    "@explain": true
}
```

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

### APIJSON Join Operations for Table Merging

Source: https://github.com/tencent/apijson/blob/master/Document.md

Illustrates the use of the 'join' keyword to combine data from multiple tables using various join types like INNER JOIN ('&'), LEFT JOIN ('<'), RIGHT JOIN ('>'), FULL JOIN ('|'), OUTER JOIN ('!'), and APP JOIN ('@'). APP JOIN is a custom join type for application-layer optimization.

```JSON
{"[]":{
 "join": "&/User,\</Comment",
 "Moment":{},
 "User":{
  "name~":"t",
  "id@": "/Moment/userId"
 },
 "Comment":{
  "momentId@": "/Moment/id"
 }
}}
```

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

### Register Stone Class Permissions

Source: https://github.com/tencent/apijson/blob/master/详细的说明文档.md

Static block in DemoVerifier.java to register permissions for the 'Stone' class, enabling the program to manage interfaces using configured class permissions.

```Java
static { //注册权限
		ACCESS_MAP.put(User.class.getSimpleName(), getAccessMap(User.class.getAnnotation(MethodAccess.class)));
....
		ACCESS_MAP.put(Stone.class.getSimpleName(), getAccessMap(Stone.class.getAnnotation(MethodAccess.class)));
	}
```

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

### APIJSON Logical Operations in URL Parameters

Source: https://github.com/tencent/apijson/blob/master/Document.md

Demonstrates the use of logical operators '&' (AND), '|' (OR), and '!' (NOT) in URL parameters for filtering data. These operators mirror SQL's AND, OR, and NOT functionalities. For the same key, '|' is used for OR operations; for different keys, '&' is used for AND operations.

```JSON
{"User":{"id&{}":">80000,<=90000"}}
```

```JSON
{"User":{"id|{}":">90000,<=80000"}}
```

```JSON
{"User":{"id!{}":[82001,38710]}}
```

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

### Group and Filter Moments with Having Clause

Source: https://github.com/tencent/apijson/blob/master/Document.md

Groups moments by 'userId', selects 'userId' and the maximum 'id', and filters groups where the maximum 'id' is 100 or greater. Demonstrates aggregation and filtering.

```json
["@column":"userId;max(id)",
"@group":"userId",
"@having":"max(id)>=100"]

```

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

### Header Format

Source: https://github.com/tencent/apijson/blob/master/CONTRIBUTING_COMMIT.md

The Header includes a mandatory 'type' and 'subject'. The type indicates the category of the commit, and the subject provides a brief description.

```markdown
<type>: <subject>
```

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

### Add / Expand an Item

Source: https://github.com/tencent/apijson/blob/master/Document.md

Add items to an array or expand a field using the `"key+":Object` format, applicable to PUT requests.

```APIDOC
## Add / Expand an Item

### Description
Add items to an array or expand a field using the `"key+":Object` format. The type of `Object` depends on the `key` (e.g., Number, String, JSONArray). This is primarily applicable to PUT requests.

### Example
```json
"praiseUserIdList+":[82001]
```
This adds the user ID `82001` to the `praiseUserIdList` array.

### SQL Equivalent
`json_insert(praiseUserIdList, 82001)`
```

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

### PUT Method

Source: https://github.com/tencent/apijson/blob/master/Document.md

Used to make changes to a specific item. Only the sent part is changed. Requires 'id' and 'tag'.

```APIDOC
## PUT /put/

### Description
Make changes to a specific item. Only change the part sent to the server.

### Method
PUT

### Endpoint
base_url/put/

### Request Body
```json
{
  "TableName":{
    "id":id,
    // ... fields to update ...
  },
  "tag":tag
}
```
You can also add multiple ids as `id{}`.

**Example:** Make changes to Moment's content with id= 235:
```json
{
  "Moment":{
    "id":235,
    "content":"APIJSON is the real-time coding-free, powerful and secure ORM"
  },
  "tag":"Moment"
}
```

### Response
Same as **POST**.
```

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

### Combine Search with OR Operator

Source: https://github.com/tencent/apijson/blob/master/Document.md

Searches for users where the 'name' or 'tag' contains the letter 'a'. This demonstrates the use of '~' for contains and '@combine' for OR logic.

```json
[
"name~":"a",
"tag~":"a",
"@combine":"name~,tag~"
]
```

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

### Generated SQL for Union Operation

Source: https://github.com/tencent/apijson/blob/master/Roadmap.md

Illustrates the SQL generated when using the @union feature to combine results from multiple conditions.

```SQL
SELECT * FROM `sys`.`apijson_user` WHERE ( (`name` REGEXP BINARY 'a') OR (`tag` REGEXP BINARY 'a') ) LIMIT 10 OFFSET 0
```

```SQL
SELECT * FROM `sys`.`apijson_user` WHERE ( (`name` REGEXP BINARY 'a') )
UNION
SELECT * FROM `sys`.`apijson_user` WHERE ( (`tag` REGEXP BINARY 'a') )
LIMIT 10 OFFSET 0
```

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

### 筛选 ID 在一定范围内的多条数据

Source: https://github.com/tencent/apijson/blob/master/详细的说明文档.md

使用 `id&{}` 语法过滤出 id 在 300 到 400 之间的多条数据，其中 `&` 表示 AND 逻辑关系。

```JSON
{
  "[]": {
      "Moment":{
        "id&{}":">=300,<=400",
        "@column":"id,date,content:text"
      }
  }
}
```
Tokens:
Raw