# apijson-router

**Repository Path**: APIJSON/apijson-router

## Basic Information

- **Project Name**: apijson-router
- **Description**: 腾讯 APIJSON 的路由插件，可控地对公网暴露类 RESTful 简单接口，内部转成 APIJSON 格式请求来执行。原仓库见
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: https://github.com/APIJSON/apijson-router
- **GVP Project**: No

## Statistics

- **Stars**: 7
- **Forks**: 3
- **Created**: 2022-04-18
- **Last Updated**: 2025-04-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: APIJSON, rest, Rest-api

## README

# apijson-router  [![](https://jitpack.io/v/APIJSON/apijson-router.svg)](https://jitpack.io/#APIJSON/apijson-router)
腾讯 [APIJSON](https://github.com/Tencent/APIJSON) 5.1.0+ 的路由插件，可控地对公网暴露类 RESTful 简单接口，内部转成 APIJSON 格式请求来执行。<br />
A router plugin for Tencent [APIJSON](https://github.com/Tencent/APIJSON) 5.1.0+, expose undercontrolled RESTful-like HTTP API, map to APIJSON request and execute.<br />

适合在公司外的公网可控地暴露 HTTP 接口，以及方便接入 ZooKeeper, Zuul, Apollo, Nacos, SpringSecurity, Shiro, Sentinel, Hystrix 等各种使用 URL 路由的 配置、鉴权、监控、限流、熔断 等网关/框架/组件。<br />
HTTP APIs can be exposed to public network and be under control, and can easily integrate Configuration/Authentication/Monitoring/Limitation/Isolatation projects(gateway, framework, component) using URL routes like ZooKeeper, Zuul, Apollo, Nacos, SpringSecurity, Shiro, Sentinel, Hystrix.

![image](https://user-images.githubusercontent.com/5738175/166560119-c598d3c6-48b6-4f47-85fe-8f36ca332e99.png)

## 添加依赖
## Add Dependency

### Maven
#### 1. 在 pom.xml 中添加 JitPack 仓库
#### 1. Add the JitPack repository to pom.xml
```xml
	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>
```

![image](https://user-images.githubusercontent.com/5738175/167263399-339dad4f-2884-461e-9781-f2de6d100340.png)

<br />

#### 2. 在 pom.xml 中添加 apijson-router 依赖
#### 2. Add the apijson-router dependency to pom.xml
```xml
	<dependency>
	    <groupId>com.github.APIJSON</groupId>
	    <artifactId>apijson-router</artifactId>
	    <version>LATEST</version>
	</dependency>
```

![image](https://user-images.githubusercontent.com/5738175/167263390-f3cc8fed-9fd5-4ee1-b8d1-e2d1a695b16c.png)

<br />

https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSONBoot-MultiDataSource/pom.xml

<br />
<br />

### Gradle
#### 1. 在项目根目录 build.gradle 中最后添加 JitPack 仓库
#### 1. Add the JitPack repository in your root build.gradle at the end of repositories
```gradle
	allprojects {
		repositories {
			maven { url 'https://jitpack.io' }
		}
	}
```
<br />

#### 2. 在项目某个 module 目录(例如 `app`) build.gradle 中添加 apijson-router 依赖
#### 2. Add the apijson-router dependency in one of your modules(such as `app`)
```gradle
	dependencies {
	        implementation 'com.github.APIJSON:apijson-router:latest'
	}
```

<br />
<br />

## 初始化
## Initialization

#### 1.新增一个 @RestController class DemoController extends APIJSONRouterController
#### 1.Add a @RestController class DemoController extends APIJSONRouterController
```java
@RestController
@RequestMapping("")
public class DemoController extends APIJSONRouterController<Long, JSONObject, JSONArray> { 
}
```
![image](https://user-images.githubusercontent.com/5738175/167263296-3bfd8782-c163-4461-bbed-f264be529e76.png)

<br />

#### 2.在 DemoController 重写 router 方法，加上注解 @PostMapping("router/{method}/{tag}")
#### 2.Override router in DemoController, and add @PostMapping("router/{method}/{tag}") for router method
```java
	@PostMapping("router/{method}/{tag}")
	@Override
	public String router(@PathVariable String method, @PathVariable String tag, @RequestParam Map<String, String> params, @RequestBody String request, HttpSession session) {
		return super.router(method, tag, params, request, session);
	}
```

![image](https://user-images.githubusercontent.com/5738175/167263339-7c7cce6e-25bf-47b1-86a3-fc2950b8938d.png)

<br />

#### 3.在 DemoApplication.main 方法内，APIJSONAppication.init 后调用 APIJSONRouterApplication.init
#### 3.In DemoApplication.main, call APIJSONRouterApplication.init after APIJSONAppication.init
```java
	public static void main(String[] args) throws Exception {
		SpringApplication.run(DemoApplication.class, args);
		APIJSONApplication.init();
		APIJSONRouterApplication.init();
	}
```

![image](https://user-images.githubusercontent.com/5738175/167263261-25fc5a02-7980-443f-94d9-76d2b488ce61.png)

<br />


参考 [APIJSONRouterController](/src/main/java/apijson/router/APIJSONRouterController.java) 的注释及 [APIJSONBoot](https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSONBoot) 的 [DemoController](https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSONBoot/src/main/java/apijson/boot/DemoController.java) 和 [DemoApplication](https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSONBoot/src/main/java/apijson/boot/DemoApplication.java) <br />

See document in [APIJSONRouterController](/src/main/java/apijson/router/APIJSONRouterController.java) and [DemoController](https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSONBoot/src/main/java/apijson/boot/DemoController.java), [DemoApplication](https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSONBoot/src/main/java/apijson/boot/DemoApplication.java)  in [APIJSONBoot](https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSONBoot)

<br />
<br />

## 使用
## Usage

#### 以下步骤 1, 2 可改为直接在 APIAuto 参数注入面板点击 \[+ 添加] 按钮，再点击弹窗内 \[发布简单接口] 按钮来自动完成
#### Instead of step 1 and 2, you can use APIAuto to complete them automatically: click \[+ Add], then click \[Release simple API]

![image](https://user-images.githubusercontent.com/5738175/166562199-4d96dd16-cf25-4bd4-b574-94a3c5f32685.png)

<br />

### 1.在 Document 表配置请求映射
### 1.Add mapping rule in table Document

例如 <br />
E.g. <br />

name: 查询动态列表

url: /router/get/momentList  // 最后必须为 /{method}/{tag} 格式：method 必须为万能通用路由名；tag 不能为 Table 或 Table\[] 格式

request:
```js
{
    "Moment[].page": 0,  // 以 . 分割路径中的 key，映射以下 "Moment[]": { "page": 0 }
    "Moment[].count": 10,  // 以 . 分割路径中的 key，映射以下 "Moment[]": { "count": 10 }
    "format": false  // 映射以下 "format": false
}
```

apijson:
```js
{
    "Moment[]": {
        "page": 0,
        "count": 10,
        "Moment": {
            "@column": "id,userId,date"
        }
    },
    "format": false
}
```

其它字段可不填，用默认值<br />
Other columns can use default value<br />

![image](https://user-images.githubusercontent.com/5738175/166565083-1db03cde-8b59-4048-af6d-78d9efb78f7c.png)

<br />

### 2.在 Request 表配置校验规则
### 2.Add validation rule in table Request

如果不需要校验参数则可跳过。 <br />
This step can be ignored if validation is not needed. <br />
 
和普通的 APIJSON 格式请求基本一致，只是不会自动根据符合表名的 tag 来对 structure 包装一层 "Table": structure <br />
The same as common APIJSON requests, but won't wrap structure with tag to "Table": structure <br />

例如 <br />
E.g. <br />

method: GET

tag: momentList

structure:
```js
{
    "MUST": "Moment[].page",  // 必传 Moment[].page
    "REFUSE": "!Moment[].count,!format,!",  // 不禁传 Moment[].count 和 format，禁传 MUST 之外的其它所有 key
    "TYPE": {
        "format": "BOOLEAN",  // format 类型必须是布尔 Boolean
        "Moment[].page": "NUMBER",  // Moment[].page 类型必须是整数 Integer
        "Moment[].count": "NUMBER"  // Moment[].count 类型必须是整数 Integer
    }
}
```

![image](https://user-images.githubusercontent.com/5738175/166563592-e8d3f09f-471a-4ae1-bee9-de78ec16fefe.png)

<br />

### 3.测试已配置的类 RESTful 简单接口
### 3.Test configured RESTful-like API

启动项目后用 APIAuto/Postman 等 HTTP 接口测试工具发起请求 <br />
After run project and the server has started, you can use HTTP tools like APIAuto/Postman to send request <br />

POST {base_url}/router/get/{tag}  // tag 可为任意符合变量名格式的字符串
```js
{
    "showKey0": val0,
    "showKey1.a1": val1,
    "showKey2.a2.b2": val2
    ...
}
```

例如 <br />
E.g. <br />

POST http://localhost:8080/router/get/momentList  // 对应 Document 表配置的 url
```js
{
    "Moment[].page": 0,
    "Moment[].count": 5,
    "format": false
}
```

如果 parser.isNeedVerifyContent，则会经过 Request 表校验规则来校验， <br />
If parser.isNeedVerifyContent, it will be validated with the rule in table Request <br />

最后内部映射为： <br />
Finally it will be mapped to： <br />

```js
{
    "Moment[]": {
        "page": 0,
        "count": 5,
        "Moment": {
            "@order": "date-"
        }
    },
    "format": false
}
```

执行完 APIJSON 格式的请求后返回对应结果 <br />
Server will execute APIJSON request and response <br />

![image](https://user-images.githubusercontent.com/5738175/166560119-c598d3c6-48b6-4f47-85fe-8f36ca332e99.png)


<br />
有问题可以去 Tencent/APIJSON 提 issue <br />
https://github.com/Tencent/APIJSON/issues/36

<br /><br />

#### 点右上角 ⭐Star 支持一下，谢谢 ^_^
#### Please ⭐Star this project ^_^
https://github.com/APIJSON/apijson-router