├── .gitignore
├── LICENSE
├── README.md
├── pom.xml
└── src
└── main
├── java
└── apijson
│ └── router
│ ├── APIJSONRouterApplication.java
│ ├── APIJSONRouterController.java
│ ├── APIJSONRouterVerifier.java
│ ├── javax
│ ├── APIJSONRouterApplication.java
│ ├── APIJSONRouterController.java
│ ├── APIJSONRouterVerifier.java
│ └── package-info.java
│ └── package-info.java
└── resources
└── application.properties
/.gitignore:
--------------------------------------------------------------------------------
1 | # Compiled class file
2 | *.class
3 |
4 | # Log file
5 | *.log
6 |
7 | # BlueJ files
8 | *.ctxt
9 |
10 | # Mobile Tools for Java (J2ME)
11 | .mtj.tmp/
12 |
13 | # Package Files #
14 | *.jar
15 | *.war
16 | *.nar
17 | *.ear
18 | *.zip
19 | *.tar.gz
20 | *.rar
21 |
22 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
23 | hs_err_pid*
24 | /target/
25 | .settings
26 | .project
27 | .classpath
28 |
29 | .idea
30 |
31 | /build/
32 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright ©2022 APIJSON(https://github.com/APIJSON)
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # apijson-router [](https://jitpack.io/#APIJSON/apijson-router)
2 | 腾讯 [APIJSON](https://github.com/Tencent/APIJSON) 5.1.0+ 的路由插件，可控地对公网暴露类 RESTful 简单接口，内部转成 APIJSON 格式请求来执行。
3 | 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.
4 |
5 | 适合在公司外的公网可控地暴露 HTTP 接口，以及方便接入 ZooKeeper, Zuul, Apollo, Nacos, SpringSecurity, Shiro, Sentinel, Hystrix 等各种使用 URL 路由的 配置、鉴权、监控、限流、熔断 等网关/框架/组件。
6 | 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.
7 |
8 | 
9 |
10 | ## 添加依赖
11 | ## Add Dependency
12 |
13 | ### Maven
14 | #### 1. 在 pom.xml 中添加 JitPack 仓库
15 | #### 1. Add the JitPack repository to pom.xml
16 | ```xml
17 |
18 |
19 | jitpack.io
20 | https://jitpack.io
21 |
22 |
23 | ```
24 |
25 | 
26 |
27 |
28 |
29 | #### 2. 在 pom.xml 中添加 apijson-router 依赖
30 | #### 2. Add the apijson-router dependency to pom.xml
31 | ```xml
32 |
33 | com.github.APIJSON
34 | apijson-router
35 | LATEST
36 |
37 | ```
38 |
39 | 
40 |
41 |
42 |
43 | https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSONBoot-MultiDataSource/pom.xml
44 |
45 |
46 |
47 |
48 | ### Gradle
49 | #### 1. 在项目根目录 build.gradle 中最后添加 JitPack 仓库
50 | #### 1. Add the JitPack repository in your root build.gradle at the end of repositories
51 | ```gradle
52 | allprojects {
53 | repositories {
54 | maven { url 'https://jitpack.io' }
55 | }
56 | }
57 | ```
58 |
59 |
60 | #### 2. 在项目某个 module 目录(例如 `app`) build.gradle 中添加 apijson-router 依赖
61 | #### 2. Add the apijson-router dependency in one of your modules(such as `app`)
62 | ```gradle
63 | dependencies {
64 | implementation 'com.github.APIJSON:apijson-router:latest'
65 | }
66 | ```
67 |
68 |
69 |
70 |
71 | ## 初始化
72 | ## Initialization
73 |
74 | #### 1.新增一个 @RestController class DemoController extends APIJSONRouterController
75 | #### 1.Add a @RestController class DemoController extends APIJSONRouterController
76 | ```java
77 | @RestController
78 | @RequestMapping("")
79 | public class DemoController extends APIJSONRouterController {
80 | }
81 | ```
82 | 
83 |
84 |
85 |
86 | #### 2.在 DemoController 重写 router 方法，加上注解 @PostMapping("router/{method}/{tag}")
87 | #### 2.Override router in DemoController, and add @PostMapping("router/{method}/{tag}") for router method
88 | ```java
89 | @PostMapping("router/{method}/{tag}")
90 | @Override
91 | public String router(@PathVariable String method, @PathVariable String tag, @RequestParam Map params, @RequestBody String request, HttpSession session) {
92 | return super.router(method, tag, params, request, session);
93 | }
94 | ```
95 |
96 | 
97 |
98 |
99 |
100 | #### 3.在 DemoApplication.main 方法内，APIJSONAppication.init 后调用 APIJSONRouterApplication.init
101 | #### 3.In DemoApplication.main, call APIJSONRouterApplication.init after APIJSONAppication.init
102 | ```java
103 | public static void main(String[] args) throws Exception {
104 | SpringApplication.run(DemoApplication.class, args);
105 | APIJSONApplication.init();
106 | APIJSONRouterApplication.init();
107 | }
108 | ```
109 |
110 | 
111 |
112 |
113 |
114 |
115 | 参考 [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)
116 |
117 | 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)
118 |
119 |
120 |
121 |
122 | ## 使用
123 | ## Usage
124 |
125 | #### 以下步骤 1, 2 可改为直接在 APIAuto 参数注入面板点击 \[+ 添加] 按钮，再点击弹窗内 \[发布简单接口] 按钮来自动完成
126 | #### Instead of step 1 and 2, you can use APIAuto to complete them automatically: click \[+ Add], then click \[Release simple API]
127 |
128 | 
129 |
130 |
131 |
132 | ### 1.在 Document 表配置请求映射
133 | ### 1.Add mapping rule in table Document
134 |
135 | 例如
136 | E.g.
137 |
138 | name: 查询动态列表
139 |
140 | url: /router/get/momentList // 最后必须为 /{method}/{tag} 格式：method 必须为万能通用路由名；tag 不能为 Table 或 Table\[] 格式
141 |
142 | request:
143 | ```js
144 | {
145 | "Moment[].page": 0, // 以 . 分割路径中的 key，映射以下 "Moment[]": { "page": 0 }
146 | "Moment[].count": 10, // 以 . 分割路径中的 key，映射以下 "Moment[]": { "count": 10 }
147 | "format": false // 映射以下 "format": false
148 | }
149 | ```
150 |
151 | apijson:
152 | ```js
153 | {
154 | "Moment[]": {
155 | "page": 0,
156 | "count": 10,
157 | "Moment": {
158 | "@column": "id,userId,date"
159 | }
160 | },
161 | "format": false
162 | }
163 | ```
164 |
165 | 其它字段可不填，用默认值
166 | Other columns can use default value
167 |
168 | 
169 |
170 |
171 |
172 | ### 2.在 Request 表配置校验规则
173 | ### 2.Add validation rule in table Request
174 |
175 | 如果不需要校验参数则可跳过。
176 | This step can be ignored if validation is not needed.
177 |
178 | 和普通的 APIJSON 格式请求基本一致，只是不会自动根据符合表名的 tag 来对 structure 包装一层 "Table": structure
179 | The same as common APIJSON requests, but won't wrap structure with tag to "Table": structure
180 |
181 | 例如
182 | E.g.
183 |
184 | method: GET
185 |
186 | tag: momentList
187 |
188 | structure:
189 | ```js
190 | {
191 | "MUST": "Moment[].page", // 必传 Moment[].page
192 | "REFUSE": "!Moment[].count,!format,!", // 不禁传 Moment[].count 和 format，禁传 MUST 之外的其它所有 key
193 | "TYPE": {
194 | "format": "BOOLEAN", // format 类型必须是布尔 Boolean
195 | "Moment[].page": "NUMBER", // Moment[].page 类型必须是整数 Integer
196 | "Moment[].count": "NUMBER" // Moment[].count 类型必须是整数 Integer
197 | }
198 | }
199 | ```
200 |
201 | 
202 |
203 |
204 |
205 | ### 3.测试已配置的类 RESTful 简单接口
206 | ### 3.Test configured RESTful-like API
207 |
208 | 启动项目后用 APIAuto/Postman 等 HTTP 接口测试工具发起请求
209 | After run project and the server has started, you can use HTTP tools like APIAuto/Postman to send request
210 |
211 | POST {base_url}/router/get/{tag} // tag 可为任意符合变量名格式的字符串
212 | ```js
213 | {
214 | "showKey0": val0,
215 | "showKey1.a1": val1,
216 | "showKey2.a2.b2": val2
217 | ...
218 | }
219 | ```
220 |
221 | 例如
222 | E.g.
223 |
224 | POST http://localhost:8080/router/get/momentList // 对应 Document 表配置的 url
225 | ```js
226 | {
227 | "Moment[].page": 0,
228 | "Moment[].count": 5,
229 | "format": false
230 | }
231 | ```
232 |
233 | 如果 parser.isNeedVerifyContent，则会经过 Request 表校验规则来校验，
234 | If parser.isNeedVerifyContent, it will be validated with the rule in table Request
235 |
236 | 最后内部映射为：
237 | Finally it will be mapped to：
238 |
239 | ```js
240 | {
241 | "Moment[]": {
242 | "page": 0,
243 | "count": 5,
244 | "Moment": {
245 | "@order": "date-"
246 | }
247 | },
248 | "format": false
249 | }
250 | ```
251 |
252 | 执行完 APIJSON 格式的请求后返回对应结果
253 | Server will execute APIJSON request and response
254 |
255 | 
256 |
257 |
258 |
259 | 有问题可以去 Tencent/APIJSON 提 issue
260 | https://github.com/Tencent/APIJSON/issues/36
261 |
262 |
263 |
264 | #### 点右上角 ⭐Star 支持一下，谢谢 ^_^
265 | #### Please ⭐Star this project ^_^
266 | https://github.com/APIJSON/apijson-router
267 |
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 | 4.0.0
5 |
6 | apijson.router
7 | apijson-router
8 | 2.1.7
9 | jar
10 |
11 | APIJSONRouter
12 | APIJSON router for mapping RESTful-like API to APIJSON API
13 |
14 |
15 | UTF-8
16 | UTF-8
17 | 1.8
18 | UTF-8
19 |
20 |
21 |
22 |
23 |
24 | jakarta.servlet
25 | jakarta.servlet-api
26 | 5.0.0
27 | provided
28 |
29 |
30 |
31 |
32 | javax.servlet
33 | javax.servlet-api
34 | 4.0.1
35 | provided
36 |
37 |
38 |
39 |
40 | com.github.Tencent
41 | APIJSON
42 | 8.0.0.1
43 |
44 |
45 | com.github.APIJSON
46 | apijson-framework
47 | 7.2.0.1
48 |
49 |
50 |
51 |
52 |
53 |
54 | org.apache.maven.plugins
55 | maven-compiler-plugin
56 | 3.12.1
57 |
58 | 1.8
59 | 1.8
60 |
61 |
62 |
63 |
64 |
65 |
66 |
67 |
68 | jitpack.io
69 | https://jitpack.io
70 |
71 |
72 |
73 |
74 |
--------------------------------------------------------------------------------
/src/main/java/apijson/router/APIJSONRouterApplication.java:
--------------------------------------------------------------------------------
1 | /*Copyright ©2022 APIJSON(https://github.com/APIJSON)
2 |
3 | Licensed under the Apache License, Version 2.0 (the "License");
4 | you may not use this file except in compliance with the License.
5 | You may obtain a copy of the License at
6 |
7 | http://www.apache.org/licenses/LICENSE-2.0
8 |
9 | Unless required by applicable law or agreed to in writing, software
10 | distributed under the License is distributed on an "AS IS" BASIS,
11 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 | See the License for the specific language governing permissions and
13 | limitations under the License.*/
14 |
15 | package apijson.router;
16 |
17 | import apijson.NotNull;
18 | import apijson.framework.APIJSONApplication;
19 | import apijson.framework.APIJSONCreator;
20 |
21 | import java.util.List;
22 | import java.util.Map;
23 |
24 |
25 | /**启动入口 Application 基类
26 | * 右键这个类 > Run As > Java Application
27 | * @author Lemon
28 | */
29 | public class APIJSONRouterApplication extends APIJSONApplication {
30 | public static final String TAG = "APIJSONRouterApplication";
31 |
32 | /**初始化，加载所有配置并校验
33 | * @return
34 | * @throws Exception
35 | */
36 | public static void init() throws Exception {
37 | init(true, DEFAULT_APIJSON_CREATOR);
38 | }
39 | /**初始化，加载所有配置并校验
40 | * @param shutdownWhenServerError
41 | * @return
42 | * @throws Exception
43 | */
44 | public static void init(boolean shutdownWhenServerError) throws Exception {
45 | init(shutdownWhenServerError, DEFAULT_APIJSON_CREATOR);
46 | }
47 | /**初始化，加载所有配置并校验
48 | * @param creator
49 | * @return
50 | * @throws Exception
51 | */
52 | public static , L extends List