2017-07-16 18:12:15 +08:00
# APIJSON
[](http://www.oracle.com/technetwork/java/api-141528.html)
[](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)
[](http://www.ecma-international.org/publications/standards/Standard.htm)
[](https://www.apache.org/licenses/LICENSE-2.0.html)
2016-11-25 01:07:32 +08:00
2017-07-16 18:12:15 +08:00
< br / >
2017-05-08 16:56:42 +08:00
2017-11-29 01:03:16 +08:00
[Java-Server ](https://github.com/TommyLemon/APIJSON/tree/master/APIJSON-Java-Server ) [Android ](https://github.com/TommyLemon/APIJSON/tree/master/APIJSON-Android ) [iOS ](https://github.com/TommyLemon/APIJSON/tree/master/APIJSON-iOS ) [JavaScript ](https://github.com/TommyLemon/APIJSON/tree/master/APIJSON-JavaScript ) [Vue.js ](https://github.com/TommyLemon/APIJSON-JS-Vue )
2017-05-08 16:56:42 +08:00
2017-10-15 02:26:00 +08:00
[English Document ](https://github.com/TommyLemon/APIJSON/blob/master/README-English.md )
2016-11-26 17:39:55 +08:00
2017-10-14 23:39:06 +08:00
[在线测试 ](http://39.108.143.172 )
2017-06-25 23:10:14 +08:00
2017-07-16 18:12:15 +08:00
< br / >
2017-04-01 17:57:35 +08:00
* ### [1.简介 ](#1 )
* ### [2.对比传统方式 ](#2 )
2017-04-01 17:42:27 +08:00
* [2.1 开发流程 ](#2.1 )
* [2.2 客户端请求 ](#2.2 )
* [2.3 服务端操作 ](#2.3 )
* [2.4 客户端解析 ](#2.4 )
2017-04-01 17:44:18 +08:00
* [2.5 对应不同需求的请求 ](#2.5 )
* [2.6 对应不同请求的结果 ](#2.6 )
2017-04-01 17:57:35 +08:00
* ### [3.对应关系总览 ](#3 )
2017-07-10 22:25:55 +08:00
* [3.1 操作方法 ](#3.1 )
* [3.2 功能符 ](#3.2 )
2017-07-10 22:53:08 +08:00
* ### [4.快速上手 ](#4 )
2017-07-10 22:30:39 +08:00
* [4.1 下载解压 ](#4.1 )
2017-09-07 21:10:13 +08:00
* [4.2 导入数据库表 ](#4.2 )
2017-07-10 22:30:39 +08:00
* [4.3 运行服务端工程 ](#4.3 )
* [4.4 运行客户端工程 ](#4.4 )
* [4.4 操作客户端App ](#4.5 )
* ### [5.其它 ](#5 )
* [5.1 相关推荐 ](#5.1 )
* [5.2 关于作者 ](#5.2 )
* [5.3 下载试用 ](#5.3 )
* [5.4 更新日志 ](#5.4 )
* [5.5 Star&Fork ](#5.5 )
2017-04-01 16:49:48 +08:00
2017-04-01 17:10:21 +08:00
## <h2 id="1">1.简介<h2/>
2017-04-01 16:49:48 +08:00
2017-12-03 02:32:03 +08:00
APIJSON是一种为API而生的JSON网络传输协议。< br / >
2017-12-03 02:34:29 +08:00
可在 简单的增删改查、复杂的查询、简单的事务操作 等场景下替代HTTP RESTful接口规范。< br / >
2017-11-22 00:43:18 +08:00
能大幅降低开发和沟通成本，简化开发流程，缩短开发周期。< br / >
2017-12-03 01:44:26 +08:00
适合中小型前后端分离的项目，尤其是互联网创业项目。< br / >
2016-11-24 22:54:11 +08:00
2017-08-20 15:42:34 +08:00
客户端可以定义任何JSON结构去向服务端发起请求， ， < br / >
2017-01-26 12:00:03 +08:00
一次请求任意结构任意数据，方便灵活，不需要专门接口或多次请求。< br / >
2017-11-22 00:43:18 +08:00
支持增删改查、模糊搜索、正则匹配、远程函数、自动化权限校验、自动化版本管理、自动生成文档和请求代码等。< br / >
还能去除重复数据，节省流量提高速度！< br / >
2016-12-09 22:09:37 +08:00
2017-11-22 00:43:18 +08:00
从此HTTP请求再也不用写接口了， ！ < br / >
2017-01-26 12:00:03 +08:00
客户端再也不用和服务端沟通接口或文档问题了！再也不会被文档各种错误坑了！< br / >
2017-07-24 00:07:42 +08:00
服务端再也不用为了兼容旧版客户端写新版接口和文档了！再也不会被客户端随时随地没完没了地烦了！
< br / >
2017-07-23 22:27:08 +08:00
[为什么要用APIJSON？ ](https://github.com/TommyLemon/APIJSON/wiki )
2016-12-09 22:09:37 +08:00
2017-11-22 00:54:34 +08:00
2017-03-06 18:43:09 +08:00
2017-07-09 13:38:24 +08:00
2017-03-06 18:43:09 +08:00
2017-08-20 15:43:40 +08:00
< br / >
< br / >
2017-03-06 18:43:09 +08:00
2017-07-09 01:24:07 +08:00
### 举几个例子:
2016-11-24 23:22:03 +08:00
2017-04-23 18:25:04 +08:00
#### 查询用户
请求：
2017-04-23 18:22:37 +08:00
< pre > < code class = "language-json" >
{
"User":{
}
< / code > < / pre >
2017-10-14 23:39:06 +08:00
[点击这里测试 ](http://39.108.143.172:8080/get/{"User":{}} )
2017-04-23 18:22:37 +08:00
2017-04-23 18:25:04 +08:00
返回：
2017-04-23 18:22:37 +08:00
< pre > < code class = "language-json" >
{
"User":{
"id":38710,
"sex":0,
"name":"TommyLemon",
"tag":"Android& Java",
"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"
]
},
2017-06-18 23:35:32 +08:00
"code":200,
"msg":"success"
2017-04-23 18:22:37 +08:00
}
< / code > < / pre >
2017-07-10 22:53:08 +08:00
< br / >
2017-04-23 18:25:04 +08:00
#### 查询用户列表
请求：
2017-04-23 18:22:37 +08:00
< pre > < code class = "language-json" >
{
"[]":{
2017-07-13 22:32:21 +08:00
2017-04-23 18:22:37 +08:00
}
}
< / code > < / pre >
2017-10-14 23:39:06 +08:00
[点击这里测试 ](http://39.108.143.172:8080/get/{"[]":{"count":3,"User":{"@column":"id,name"}}} )
2017-04-23 18:22:37 +08:00
2017-04-23 18:25:04 +08:00
返回：
2017-04-23 18:22:37 +08:00
< pre > < code class = "language-json" >
{
2017-04-30 10:49:22 +08:00
"[]":[
{
2017-04-23 18:22:37 +08:00
"User":{
"id":38710,
"name":"TommyLemon"
}
},
2017-04-30 10:49:22 +08:00
{
2017-04-23 18:22:37 +08:00
"User":{
"id":70793,
"name":"Strong"
}
},
2017-04-30 10:49:22 +08:00
{
2017-04-23 18:22:37 +08:00
"User":{
"id":82001,
"name":"Android"
}
}
2017-04-30 10:49:22 +08:00
],
2017-06-18 23:35:32 +08:00
"code":200,
"msg":"success"
2017-04-23 18:22:37 +08:00
}
< / code > < / pre >
2017-07-10 22:53:08 +08:00
< br / >
2017-07-13 22:32:21 +08:00
#### 查询动态及发布者用户
请求：
< pre > < code class = "language-json" >
{
"Moment":{
},
"User":{
"id@":"Moment/userId" //User.id = Moment.userId
}
}
< / code > < / pre >
2017-10-14 23:39:06 +08:00
[点击这里测试 ](http://39.108.143.172:8080/get/{"Moment":{},"User":{"id@":"Moment%252FuserId"}} )
2017-07-13 22:32:21 +08:00
返回：
< pre > < code class = "language-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
2017-07-13 22:35:05 +08:00
],
2017-07-13 22:32:21 +08:00
"date":"2017-02-01 19:21:50.0"
},
"code":200,
"msg":"success"
}
< / code > < / pre >
< br / >
2017-04-23 18:25:04 +08:00
#### 查询类似微信朋友圈的动态列表
请求：
2017-04-23 17:48:56 +08:00
< pre > < code class = "language-json" >
2017-04-23 17:28:06 +08:00
{
2017-06-19 00:57:07 +08:00
"[]":{ //请求一个数组
"page":0,
2017-04-23 17:30:57 +08:00
"count":2,
2017-06-19 00:57:07 +08:00
"Moment":{
2017-06-19 01:08:27 +08:00
"content$":"%a%" ，
2017-04-23 17:30:57 +08:00
},
2017-06-19 00:57:07 +08:00
"User":{
2017-07-08 20:13:03 +08:00
2017-06-19 00:57:07 +08:00
"@column":"id,name,head"
},
"Comment[]":{ //请求一个名为Comment的数组，
2017-04-23 17:28:06 +08:00
"count":2,
"Comment":{
2017-07-08 20:13:03 +08:00
"momentId@":"[]/Moment/id" //Comment.momentId = Moment.id 完整引用赋值路径
2017-04-23 17:28:06 +08:00
}
}
}
}
< / code > < / pre >
2017-10-14 23:39:06 +08:00
[点击这里测试 ](http://39.108.143.172:8080/get/{"[]":{"page":0,"count":2,"Moment":{"content$":"%2525a%2525"},"User":{"id@":"%252FMoment%252FuserId","@column":"id,name,head"},"Comment[]":{"count":2,"Comment":{"momentId@":"[]%252FMoment%252Fid"}}}} )
2017-01-26 12:00:03 +08:00
2017-04-23 18:25:04 +08:00
返回：
2017-04-23 17:48:56 +08:00
< pre > < code class = "language-json" >
{
2017-04-30 10:49:22 +08:00
"[]":[
{
2017-04-23 17:48:56 +08:00
"Moment":{
2017-06-19 00:57:07 +08:00
"id":15,
"userId":70793,
2017-04-23 17:48:56 +08:00
"date":1486541171000,
2017-06-19 00:57:07 +08:00
"content":"APIJSON
"praiseUserIdList":[
82055,
82002,
82001
],
2017-04-23 17:48:56 +08:00
"pictureList":[
2017-06-19 00:57:07 +08:00
"http://static.oschina.net/uploads/user/1218/2437072_100.jpg?t=1461076033000",
"http://common.cnblogs.com/images/icon_weibo_24.png"
2017-04-23 17:48:56 +08:00
]
},
2017-06-19 00:57:07 +08:00
"User":{
"id":70793,
"name":"Strong",
"head":"http://static.oschina.net/uploads/user/585/1170143_50.jpg?t=1390226446000"
},
2017-04-30 10:49:22 +08:00
"Comment[]":[
{
2017-06-19 00:57:07 +08:00
"id":176,
"toId":166,
"userId":38710,
"momentId":15,
"date":1490444883000,
"content":"thank you"
2017-04-23 17:48:56 +08:00
},
2017-04-30 10:49:22 +08:00
{
2017-06-19 00:57:07 +08:00
"id":1490863469638,
"toId":0,
"userId":82002,
"momentId":15,
"date":1490863469000,
"content":"Just do it"
2017-04-23 17:48:56 +08:00
}
2017-04-30 10:49:22 +08:00
]
2017-04-23 17:48:56 +08:00
},
2017-04-30 10:49:22 +08:00
{
2017-04-23 17:48:56 +08:00
"Moment":{
2017-06-19 00:57:07 +08:00
"id":58,
"userId":90814,
"date":1485947671000,
"content":"This is a Content...-435",
"praiseUserIdList":[
38710,
82003,
82005,
93793,
82006,
82044,
82001
],
2017-04-23 17:48:56 +08:00
"pictureList":[
2017-06-19 00:57:07 +08:00
"http://static.oschina.net/uploads/img/201604/22172507_aMmH.jpg"
2017-04-23 17:48:56 +08:00
]
},
2017-06-19 00:57:07 +08:00
"User":{
"id":90814,
"name":7,
"head":"http://static.oschina.net/uploads/user/51/102723_50.jpg?t=1449212504000"
},
2017-04-30 10:49:22 +08:00
"Comment[]":[
{
2017-06-19 00:57:07 +08:00
"id":13,
"toId":0,
"userId":82005,
"momentId":58,
"date":1485948050000,
"content":"This is a Content...-13"
2017-04-23 17:48:56 +08:00
},
2017-04-30 10:49:22 +08:00
{
2017-06-19 00:57:07 +08:00
"id":77,
"toId":13,
"userId":93793,
"momentId":58,
"date":1485948050000,
"content":"This is a Content...-77"
2017-04-23 17:48:56 +08:00
}
2017-04-30 10:49:22 +08:00
]
2017-04-23 17:48:56 +08:00
}
2017-04-30 10:49:22 +08:00
],
2017-06-18 23:35:32 +08:00
"code":200,
"msg":"success"
2017-04-23 17:48:56 +08:00
}
< / code > < / pre >
2016-11-24 23:22:03 +08:00
2017-06-25 23:10:14 +08:00
< br / >
2017-10-14 23:39:06 +08:00
[在线测试 ](http://39.108.143.172 )
2016-11-25 00:29:39 +08:00
2017-07-10 22:53:08 +08:00
< br / >
2017-06-25 23:10:14 +08:00
< br / >
2017-03-04 19:59:01 +08:00
2017-04-01 17:23:49 +08:00
## <h2 id="2">2.对比传统RESTful方式<h2/>
2017-04-01 17:42:27 +08:00
### <h3 id="2.1">2.1 开发流程<h3/>
2017-01-26 12:00:03 +08:00
开发流程 | 传统方式 | APIJSON
2016-12-06 20:31:52 +08:00
-------- | ------------ | ------------
2017-04-01 12:05:30 +08:00
接口传输 | 等服务端编辑接口，然后更新文档，客户端再按照文档编辑请求和解析代码 | 客户端按照自己的需求编辑请求和解析代码。< br / > 没有接口，更不需要文档！客户端再也不用和服务端沟通接口或文档问题了！
2017-01-26 12:00:03 +08:00
兼容旧版 | 服务端增加新接口， ，
2016-12-06 20:31:52 +08:00
2017-07-10 22:53:08 +08:00
< br / >
2017-04-01 17:42:27 +08:00
### <h3 id="2.2">2.2 客户端请求<h3/>
2017-01-26 12:00:03 +08:00
客户端请求 | 传统方式 | APIJSON
2016-12-06 20:31:52 +08:00
-------- | ------------ | ------------
2017-07-16 18:50:26 +08:00
要求 | 客户端按照文档在对应URL后面拼接键值对 | 客户端按照自己的需求在固定URL后拼接JSON
2017-08-20 15:53:39 +08:00
结构 | 同一个URL内table_name只能有一个 < br / > < br / > base_url/get/table_name?< br / > key0=value0& key1=value1... | 同一个URL后TableName可传任意数量个 < br / > < br / > base_url/get/< br / > {< br > TableName0:{< br > key0:value0,< br > key1:value1,< br > ...< br > },< br > TableName1:{< br > ...< br > }< br > ...< br > }
2017-08-20 15:52:01 +08:00
URL | 不同的请求对应不同的URL， ， < br / > 大部分请求都用7个通用接口URL的其中一个
2017-01-26 12:00:03 +08:00
键值对 | key=value | key:value
2016-12-06 20:31:52 +08:00
2017-07-10 22:53:08 +08:00
< br / >
2017-04-01 17:42:27 +08:00
### <h3 id="2.3">2.3 服务端操作<h3/>
2017-01-26 12:00:03 +08:00
服务端操作 | 传统方式 | APIJSON
2016-12-06 20:31:52 +08:00
-------- | ------------ | ------------
2017-04-05 11:07:23 +08:00
解析和返回 | 取出键值对， ，
2017-01-26 12:00:03 +08:00
返回JSON结构的设定方式 | 由服务端设定，客户端不能修改 | 由客户端设定，服务端不能修改
2016-12-06 20:31:52 +08:00
2017-07-10 22:53:08 +08:00
< br / >
2017-04-01 17:42:27 +08:00
### <h3 id="2.4">2.4 客户端解析<h3/>
2017-01-26 12:00:03 +08:00
客户端解析 | 传统方式 | APIJSON
2016-12-06 20:31:52 +08:00
-------- | ------------ | ------------
2017-07-16 18:40:45 +08:00
查看方式 | 查文档或问后端，或等请求成功后看日志 | 看请求就行，所求即所得，不用查、不用问、不用等。也可以等请求成功后看日志
2017-07-16 18:41:25 +08:00
解析方法 | 用JSON解析器来解析JSONObject | 可以用JSONResponse解析JSONObject，
2017-04-01 17:42:27 +08:00
2017-07-10 22:53:08 +08:00
< br / >
2017-04-01 17:42:27 +08:00
### <h3 id="2.5">2.5 客户端对应不同需求的请求<h3/>
2017-08-20 15:46:07 +08:00
客户端的请求 | 传统方式 | APIJSON
2016-12-06 20:31:52 +08:00
-------- | ------------ | ------------
2017-10-14 23:39:06 +08:00
User | base_url/get/user?id=38710 | [base_url/get/<br >{<br > "User":{<br > "id":38710<br > }<br >} ](http://39.108.143.172:8080/get/{"User":{"id":38710}} )
Moment和对应的User | 分两次请求< br /> Moment: < br /> base_url/get/moment?userId=38710< br />< br /> User: < br /> base_url/get/user?id=38710 | [base_url/get/<br >{<br > "Moment":{<br > "userId":38710<br > }, <br > "User":{<br > "id":38710<br > }<br >} ](http://39.108.143.172:8080/get/{"Moment":{"userId":38710},"User":{"id":38710}} )
User列表 | base_url/get/user/list?< br / > page=0& count=3& sex=0 | [base_url/get/< br > {< br > "User[]":{< br > "page":0,< br > "count":3, < br > "User":{< br > "sex":0< br > }< br > }< br > }](http://39.108.143.172:8080/get/{"User[]":{"page":0,"count":3,"User":{"sex":0}}})
Moment列表， < br / > 每个Moment包括< br / > 1.发布者User< br / > 2.前3条Comment | Moment里必须有< br / > 1.User对象< br > 2.Comment数组< br / > < br / > base_url/get/moment/list?< br / > page=0& count=3& commentCount=3 | [base_url/get/< br > {< br > "[]":{< br > "page":0, < br > "count":3, < br > "Moment":{}, < br > "User":{< br > "id@":"/Moment/userId"< br > },< br > "Comment[]":{< br > "count":3,< br > "Comment":{< br > "momentId@":"[]/Moment/id"< br > }< br > }< br > }< br > }](http://39.108.143.172:8080/get/{"[]":{"page":0,"count":3,"Moment":{},"User":{"id@":"%252FMoment%252FuserId"},"Comment[]":{"count":3,"Comment":{"momentId@":"[]%252FMoment%252Fid"}}}})
User发布的Moment列表， < br / > 每个Moment包括< br / > 1.发布者User< br / > 2.前3条Comment | 1.Moment里必须有User对象和Comment数组< br > 2.字段名必须查接口文档，例如评论数量字段名可能是< br / > commentCount,comment_count或者简写cmt_count等各种奇葩写法... < br / > < br / > base_url/get/moment/list?< br / > page=0& count=3< br / > & commentCount=3& userId=38710 | 有以下几种方式:< br / > < br / > ① 把以上请求里的< br > "Moment":{}, "User":{"id@":"/Moment/userId"}< br > 改为< br > ["Moment":{"userId":38710}, "User":{"id":38710}](http://39.108.143.172:8080/get/{"[]":{"page":0,"count":3,"Moment":{"userId":38710},"User":{"id":38710},"Comment[]":{"count":3,"Comment":{"momentId@":"[]%252FMoment%252Fid"}}}}) < br / > < br / > ② 或把User放在上面的最外层省去重复的User< br / > [base_url/get/< br > {< br > "User":{< br > "id":38710< br > },< br > "[]":{< br > "page":0,< br > "count":3, < br > "Moment":{< br > "userId":38710< br > }, < br > "Comment[]":{< br > "count":3,< br > "Comment":{< br > "momentId@":"[]/Moment/id"< br > }< br > }< br > }< br > }](http://39.108.143.172:8080/get/{"User":{"id":38710},"[]":{"page":0,"count":3,"Moment":{"userId":38710},"Comment[]":{"count":3,"Comment":{"momentId@":"[]%252FMoment%252Fid"}}}})< br / > < br / > ③ 如果User之前已经获取到了， < br / > [base_url/get/< br > {< br > "[]":{< br > "page":0,< br > "count":3, < br > "Moment":{< br > "userId":38710< br > },< br > "Comment[]":{< br > "count":3,< br > "Comment":{< br > "momentId@":"[]/Moment/id"< br > }< br > }< br > }< br > }](http://39.108.143.172:8080/get/{"[]":{"page":0,"count":3,"Moment":{"userId":38710},"Comment[]":{"count":3,"Comment":{"momentId@":"[]%252FMoment%252Fid"}}}})
2016-12-06 20:31:52 +08:00
2017-07-10 22:53:08 +08:00
< br / >
2017-04-01 17:42:27 +08:00
### <h3 id="2.6">2.6 服务端对应不同请求的返回结果<h3/>
2017-08-20 15:46:07 +08:00
服务端的返回结果 | 传统方式 | APIJSON
2016-12-06 20:31:52 +08:00
-------- | ------------ | ------------
2017-07-16 14:44:33 +08:00
User | {< br > "data":{< br > "id":38710,< br > "name":"xxx",< br > ...< br > },< br > "code":200,< br > "msg":"success"< br > } | {< br > "User":{< br > "id":38710,< br > "name":"xxx",< br > ...< br > },< br > "code":200,< br > "msg":"success"< br > }
2017-07-16 14:59:46 +08:00
Moment和对应的User | 分别返回两次请求的结果， < br / > < br / > Moment: < br > {< br > "data":{< br > "id":235,< br > "content":"xxx",< br > ...< br > },< br > "code":200,< br > "msg":"success"< br > } < br / > < br / > User: < br > {< br > "data":{< br > "id":38710,< br > "name":"xxx",< br > ...< br > },< br > "code":200,< br > "msg":"success"< br > } | 一次性返回，没有传统方式导致的 长时间等待结果、两次结果间关联、线程多次切换 等问题 < br / > < br / > {< br > "Moment":{< br > "id":235,< br > "content":"xxx",< br > ...< br > },< br > "User":{< br > "id":38710,< br > "name":"xxx",< br > ...< br > },< br > "code":200,< br > "msg":"success"< br > }
2017-07-16 14:44:33 +08:00
User列表 | {< br > "data":[< br > {< br > "id":38710,< br > "name":"xxx",< br > ...< br > },< br > {< br > "id":82001,< br > ...< br > },< br > ...< br > ],< br > "code":200,< br > "msg":"success"< br > } | {< br > "User[]":[< br > {< br > "id":38710,< br > "name":"xxx",< br > ...< br > },< br > {< br > "id":82001,< br > ...< br > },< br > ...< br > ],< br > "code":200,< br > "msg":"success"< br > }
2017-07-16 15:29:06 +08:00
Moment列表， < br / > 1.User对象< br / > 2.Comment数组 < br / > < br / > {< br > "data":[< br > {< br > "id":235,< br > "content":"xxx",< br > ...,< br > "User":{< br > ...< br > },< br > "Comment":[< br > ...< br > ]< br > },< br > {< br > "id":301,< br > "content":"xxx",< br > ...,< br > "User":{< br > ...< br > },< br > ...< br > },< br > ...< br > ],< br > "code":200,< br > "msg":"success"< br > } | 1.高灵活，可任意组合< br / > 2.低耦合，逻辑很清晰< br / > < br / > {< br > "[]":[< br > {< br > "Moment":{< br > "id":235,< br > "content":"xxx",< br > ...< br > },< br > "User":{< br > ...< br > },< br > "Comment[]":[< br > ...< br > ]< br > },< br > {< br > "Moment":{< br > "id":301,< br > "content":"xxx",< br > ...< br > },< br > "User":{< br > ...< br > },< br > ...< br > },< br > ...< br > ],< br > "code":200,< br > "msg":"success"< br > }
2017-07-16 16:15:24 +08:00
User发布的Moment列表， ， < br / > 2.优化很繁琐，需要后端扩展接口、写好文档，前端/客户端再配合优化< br / > < br / > {< br > "data":[< br > {< br > "id":235,< br > "content":"xxx",< br > ...,< br > "User":{< br > "id":38710,< br > "name":"Tommy"< br > ...< br > },< br > "Comment":[< br > ...< br > ]< br > ...< br > },< br > {< br > "id":470,< br > "content":"xxx",< br > ...,< br > "User":{< br > "id":38710,< br > "name":"Tommy"< br > ...< br > },< br > "Comment":[< br > ...< br > ]< br > ...< br > },< br > {< br > "id":511,< br > "content":"xxx",< br > ...,< br > "User":{< br > "id":38710,< br > "name":"Tommy"< br > ...< br > },< br > "Comment":[< br > ...< br > ]< br > ...< br > },< br > {< br > "id":595,< br > "content":"xxx",< br > ...,< br > "User":{< br > "id":38710,< br > "name":"Tommy"< br > ...< br > },< br > "Comment":[< br > ...< br > ]< br > ...< br > },< br > ...< br > ],< br > "code":200,< br > "msg":"success"< br > } | 以上不同请求方式的结果:< br / > < br / > ① 常规请求 < br > {< br > "[]":[< br > {< br > "Moment":{< br > "id":235,< br > "content":"xxx",< br > ...< br > },< br > "User":{< br > "id":38710,< br > "name":"Tommy"< br > ...< br > },< br > "Comment[]":[< br > ...< br > &
2016-12-06 20:31:52 +08:00
2017-03-08 00:35:13 +08:00
2017-07-10 22:53:08 +08:00
1.base_url指基地址， ， ， < br >
2.请求中的key或value任意一个为null值时， < br >
3.请求中的 / 需要转义。JSONRequest.java已经用URLEncoder.encode转义， ； ， < br >
2017-07-10 21:51:55 +08:00
4.code， ， ， ， < br >
5.msg， ， < br >
2017-07-10 22:17:26 +08:00
6.code和msg总是在返回结果的同一层级成对出现。对所有请求的返回结果都会在最外层有一对总结式code和msg。对非GET类型的请求， < br >
2017-07-10 21:51:55 +08:00
7.id等字段对应的值仅供说明， ，
2017-03-06 14:03:31 +08:00
2017-07-10 22:53:08 +08:00
< br / >
< br / >
2017-07-10 22:25:55 +08:00
## <h2 id="3">3.对应关系总览<h2/>
### <h3 id="3.1">3.1 操作方法<h3/>
2017-03-08 00:03:02 +08:00
2017-03-07 23:37:01 +08:00
方法及说明 | URL | Request | Response
------------ | ------------ | ------------ | ------------
2017-07-16 14:59:46 +08:00
GET: < br > 普通获取数据，< br > 明文，< br > 可用浏览器调试 | base_url/get/ | {< br > TableName:{< br > … < br > }< br > } < br > {…}内为限制条件< br > < br > 例如获取一个id为235的Moment： < br > {< br > "Moment":{< br > "id":235< br > }< br > } | {< br > TableName:{< br > ...< br > },< br > "code":200,< br > "msg":"success"< br > }< br > 例如< br > {< br > "Moment":{< br > "id":235,< br > "userId":38710,< br > "content":"APIJSON,let interfaces and documents go to hell !"< br > },< br > "code":200,< br > "msg":"success"< br > }
HEAD: < br > 普通获取数量，< br > 明文，< br > 可用浏览器调试 | base_url/head/ | {< br > TableName:{< br > …< br > }< br > } < br > {…}内为限制条件 < br > < br > 例如获取一个id为38710的User所发布的Moment总数： < br > {< br > "Moment":{< br > "userId":38710< br > }< br > } | {< br > TableName:{< br > "code":200,< br > "msg":"success",< br > "count":10< br > },< br > "code":200,< br > "msg":"success"< br > } < br > 例如< br > {< br > "Moment":{< br > "code":200,< br > "msg":"success",< br > "count":10< br > },< br > "code":200,< br > "msg":"success"< br > }
2017-10-15 03:02:25 +08:00
GETS: < br > 安全/私密获取数据，< br > 非明文，< br > 用于获取钱包等< br > 对安全性要求高的数据 | base_url/gets/ | 最外层加一个"tag":tag，
HEADS: < br > 安全/私密获取数量，< br > 非明文，< br > 用于获取银行卡数量等< br > 对安全性要求高的数据总数 | base_url/heads/ | 最外层加一个"tag":tag，
2017-07-16 14:59:46 +08:00
POST: < br > 新增数据，< br > 非明文 | base_url/post/ | {< br > TableName:{< br > …< br > },< br > "tag":tag< br > } < br > {…}中id由服务端生成， < br > < br > 例如一个id为38710的User发布一个新Moment： < br > {< br > "Moment":{< br > "userId":38710,< br > "content":"APIJSON,let interfaces and documents go to hell !"< br > },< br > "tag":"Moment"< br > } | {< br > TableName:{< br > "code":200,< br > "msg":"success",< br > "id":38710< br > },< br > "code":200,< br > "msg":"success"< br > }< br > 例如< br > {< br > "Moment":{< br > "code":200,< br > "msg":"success",< br > "id":120< br > },< br > "code":200,< br > "msg":"success"< br > }
PUT: < br > 修改数据，< br > 非明文，< br > 只修改所传的字段 | base_url/put/ | {< br > TableName:{< br > "id":id,< br > …< br > },< br > "tag":tag< br > } < br > {…}中id必传 < br > < br > 例如修改id为235的Moment的content： < br > {< br > "Moment":{< br > "id":235,< br > "content":"APIJSON,let interfaces and documents go to hell !"< br > },< br > "tag":"Moment"< br > } | 同POST
DELETE: < br > 删除数据，< br > 非明文 | base_url/delete/ | {< br > TableName:{< br > "id":id< br > },< br > "tag":tag< br > } < br > {…}中id必传， < br > < br > 例如删除id为120的Moment： < br > {< br > "Moment":{< br > "id":120< br > },< br > "tag":"Moment"< br > } | 同POST
2017-03-08 00:13:07 +08:00
2017-03-08 00:35:13 +08:00
2017-07-16 13:01:34 +08:00
1.TableName指要查询的数据库表Table的名称字符串。第一个字符为大写字母， ， ， < br >
2017-07-10 22:53:08 +08:00
2."tag":tag 后面的tag是非GET、HEAD请求中匹配请求的JSON结构的key， ， < br >
3.GET、HEAD请求是开放请求， < br >
2017-10-15 02:26:00 +08:00
4.GETS与GET、HEADS与HEAD分别为同一类型的操作方法， < br >
2017-07-16 12:56:59 +08:00
5.在HTTP通信中， ， < br >
6.所有JSONObject都视为容器(或者文件夹)，结构为 {...} ，里面可以放普通对象或子容器。下同。< br >
2017-08-20 00:48:09 +08:00
7.每个对象都有一个唯一的路径(或者叫地址)， ，
2017-04-04 12:59:46 +08:00
2017-07-10 22:53:08 +08:00
< br >
2017-03-08 00:32:13 +08:00
2017-07-10 22:25:55 +08:00
### <h3 id="3.2">3.2 功能符<h3/>
2017-03-07 22:43:41 +08:00
2017-05-12 16:16:03 +08:00
功能 | 键值对格式 | 使用示例
2017-03-07 22:43:41 +08:00
------------ | ------------ | ------------
2017-10-14 23:39:06 +08:00
查询数组 | "key[]":{}， ， ， ， ， ， ，
匹配选项范围 | "key{}":[]， ， ，
匹配条件范围 | "key{}":"条件0,条件1..."， ， "id{}":"<=80000,\>90000" ](http://39.108.143.172:8080/get/{"User[]":{"count":3,"User":{"id{}":"<=80000,\>90000"}}} )，
包含选项范围 | "key< \>":Object => "key< \>":[Object]， ， "contactIdList<\>":38710 ](http://39.108.143.172:8080/get/{"User[]":{"count":3,"User":{"contactIdList<\>":38710}}} )，
远程调用函数 | "key()":"函数表达式"，函数表达式为 function(Type0:value0,Type1:value1...)。函数参数类型为Object或泛型时可省略类型， "isPraised()":"isContain(Collection:praiseUserIdList,userId)" ](http://39.108.143.172:8080/get/{"Moment":{"id":301,"isPraised( )":"isContain(Collection:praiseUserIdList,userId)"}})，请求完成后会调用 boolean isContain(Collection collection, Object object) 函数，然后变为 "isPraised":true 这种（ ， ）
引用赋值 | "key@":"引用路径"，引用路径为用/分隔的字符串。以/开头的是缺省引用路径， ； ， < br /> 被引用的refKey必须在声明key的上面。如果对refKey的容器指定了返回字段， ， "Moment":{<br /> "userId":38710<br />},<br />"User":{<br /> "id@":"/Moment/userId"<br />} ](http://39.108.143.172:8080/get/{"Moment":{"userId":38710},"User":{"id@":"%252FMoment%252FuserId"}} )< br /> User内的id引用了与User同级的Moment内的userId， < br /> 即User.id = Moment.userId， < br > "id@":"/Moment/userId" 会变成 "id":38710
模糊搜索 | "key$":"SQL搜索表达式" => "key$":["SQL搜索表达式"]， ， "name$":"%m%" ](http://39.108.143.172:8080/get/{"User[]":{"count":3,"User":{"name$":"%2525m%2525"}}} )，
正则匹配 | "key?":"正则表达式" => "key?":["正则表达式"]，任意正则表达式字符串，如 ^[0-9]+$ ，可用于高级搜索 | ["name?":"^[0-9]+$"](http://39.108.143.172:8080/get/{"User[]":{"count":3,"User":{"name%253F":"^[0-9]%252B$"}}})，
新建别名 | "name:alias"， ， "@column":"toId:parentId" ](http://39.108.143.172:8080/get/{"Comment":{"@column":"id,toId:parentId","id":51}} )，
2017-07-16 14:59:46 +08:00
增加 或 扩展 | "key+":Object， ， ， ，
2017-07-16 13:04:40 +08:00
减少 或 去除 | "key-":Object， ， ，
2017-10-14 23:39:06 +08:00
逻辑运算 | & , \|, ! 逻辑运算符。< br /> ① & 可用于"key& {}":"条件"等< br /> ② \| 可用于"key\|{}":"条件", "key\|{}":[]等，一般可省略< br /> ③ ! 可单独使用，如"key!":Object， & ,\|一样配合其他功能符使用 | ① ["id&{}":">80000,<=90000" ](http://39.108.143.172:8080/head/{"User":{"id&{}":">80000,<=90000"}} )， & id< =90000< br /> ② ["id\|{}":">90000,<=80000" ](http://39.108.143.172:8080/head/{"User":{"id\|{}":">90000,<=80000"}} )，同"id{}":">90000,< =80000"， < =80000< br /> ③ ["id!{}":[82001,38710]](http://39.108.143.172:8080/head/{"User":{"id!{}":[82001,38710]}})，
数组关键词 | "key":Object， ， < br / > ① "count":Integer， ， ， ， ； < br / > ② "page":Integer， ， ， < br / > ③ "query":Integer， < br / > 0-对象， ， < br / > 总数关键词为total， ， ， < br / > 这里query及total仅为GET类型的请求提供方便， ， ： < br / > ["count":5](http://39.108.143.172:8080/get/{"[]":{"count":5,"User":{}}})< br / > ② 查询第3页的User数组， ： < br / > ["count":5,< br / > "page":3](http://39.108.143.172:8080/get/{"[]":{"count":5,"page":3,"User":{}}})< br / > ③ 查询User数组和对应的User总数： < br / > ["[]":{< br / > "query":2,< br / > "User":{}< br / > },< br / > "total@":"/[]/total"](http://39.108.143.172:8080/get/{"[]":{"query":2,"count":5,"User":{}},"total@":"%252F[]%252Ftotal"})
对象关键词，可自定义 | "@key":Object， ， < br / > ① "@about":true, 查询字段属性< br / > ② "@column":"key0,key1...", 指定返回字段< br / > ③ "@order":"key0,key1+,key2-..."，指定排序方式< br / > ④ "@group":"key0,key1,key2..."，指定分组方式。如果@column里声明了Table的id， ； < br / > 1.分组的key在@column里声明< br / > 2.Table主键在@group中声明 < br / > ⑤ "@having":"function0(...)?valu0,function1(...)?valu1,function2(...)?value2..."， ， ， ： < br / > ["@about":true](http://39.108.143.172:8080/get/{"User[]":{"User":{"@about":true}}})< br / > ② 只查询id,sex,name这几列并且请求结果也按照这个顺序： < br / > ["@column":"id,sex,name"](http://39.108.143.172:8080/get/{"User":{"@column":"id,sex,name","id":38710}})< br / > ③ 查询按 name降序、id默认顺序 排序的User数组： < br / > ["@order":"name-,id"](http://39.108.143.172:8080/get/{"[]":{"count":10,"User":{"@column":"name,id","@order":"name-,id"}}})< br / > ④ 查询按userId分组的Moment数组： < br / > ["@group":"userId,id"](http://39.108.143.172:8080/get/{"[]":{"count":10,"Moment":%7B"@column":"userId,id","@group":"userId,id"}}})< br / > ⑤ 查询 按userId分组、id最大值>=100 的Moment数组： < br / > ["@column":"userId,max(id)",< br / > "@group":"userId",< br / > "@having":"max(id)>=100"](http://39.108.143.172:8080/get/{"[]":{"count":10,"Moment":{"@column":"userId,max(id)","@group":"userId","@having":"max(id)>=100"}}})< br / > 还可以指定函数返回名：< br / > ["@column":"userId,max(id):maxId",< br / > "@group":"userId",< br / > "@having":"maxId>=100"](http://39.108.143.172:8080/get/{"[]":{"count":10,"Moment":{"@column":"userId,max(id):maxId","@group":"userId","@having":"maxId>=100"}}})< br / > ⑥ 从pictureList获取第0张图片： < br / > ["@position":0, //这里@position为自定义关键词< br / > "firstPicture()":"get(Collection:pictureList,int:@position)"](http://39.108.143.172:8080/get/{"User":{"id":38710,"@position":0,"firstPicture()":"get(Collection:pictureList,int:@position)"}})< br / > ...
2017-07-02 18:00:16 +08:00
2017-07-10 22:53:08 +08:00
< br >
< br >
2017-07-02 18:00:16 +08:00
2017-07-10 22:53:08 +08:00
## <h2 id="4">4.快速上手<h2/>
2016-11-25 01:07:32 +08:00
2017-07-10 22:30:39 +08:00
### <h3 id="4.1">4.1 下载后解压APIJSON工程<h3/>
2016-11-25 01:07:32 +08:00
2017-01-26 12:00:03 +08:00
Clone or download > Download ZIP > 解压到一个路径并记住这个路径。
2016-11-25 01:07:32 +08:00
2017-10-14 23:39:06 +08:00
#### 你可以跳过步骤4.2和步骤4.3，
2016-12-17 20:25:40 +08:00
2017-09-07 21:09:29 +08:00
### <h3 id="4.2">4.2 导入表文件到数据库<h3/>
2016-11-25 01:07:32 +08:00
2017-01-26 12:00:03 +08:00
服务端需要MySQL Server和MySQLWorkbench， < br / >
我的配置是Windows 7 + MySQL Community Server 5.7.16 + MySQLWorkbench 6.3.7 和 OSX EI Capitan + MySQL Community Server 5.7.16 + MySQLWorkbench 6.3.8，
2016-12-09 22:34:22 +08:00
2017-01-26 12:00:03 +08:00
启动MySQLWorkbench > 进入一个Connection > 点击Server菜单 > Data Import > 选择刚才解压路径下的APIJSON-Master/table > Start Import > 刷新SCHEMAS, 左下方sys/tables会出现添加的table。
2016-11-25 01:07:32 +08:00
2017-07-10 22:33:57 +08:00
### <h3 id="4.3">4.3 用Eclipse for JavaEE或IntellIJ IDEA Ultimate运行服务端工程<h3/>
2016-11-25 01:07:32 +08:00
2017-01-26 15:41:57 +08:00
如果以上编辑器一个都没安装，运行前先下载安装一个。< br / >
2017-01-30 22:17:18 +08:00
我的配置是Windows 7 + JDK 1.7.0_71 + Eclipse 4.6.1 + IntellIJ 2016.3 和 OSX EI Capitan + JDK 1.8.0_91 + Eclipse 4.6.1 + IntellIJ 2016.2.5
2016-11-25 01:07:32 +08:00
2016-12-07 23:13:50 +08:00
#### Eclipse for JavaEE
2016-11-25 01:07:32 +08:00
2017-01-26 12:00:03 +08:00
1.导入< br / >
File > Import > Maven > Existing Maven Projects > Next > Browse > 选择刚才解压路径下的APIJSON-Master/APIJSON(Server)/APIJSON(Eclipse_JEE) > Finish
2016-12-07 23:13:50 +08:00
2017-01-26 12:00:03 +08:00
2.运行< br / >
Run > Run As > Java Application > 选择APIJSONApplication > OK
2016-12-07 23:13:50 +08:00
#### IntellIJ IDEA Ultimate
2017-01-26 12:00:03 +08:00
1.导入< br / >
Open > 选择刚才解压路径下的APIJSON-Master/APIJSON(Server)/APIJSON(Idea) > OK
2016-12-07 23:13:50 +08:00
2017-01-26 12:00:03 +08:00
2.运行< br / >
2016-12-07 23:13:50 +08:00
Run > Run APIJSONApplication
2017-07-10 22:30:39 +08:00
### <h3 id="4.4">4.4 用ADT Bundle或Android Studio运行客户端工程<h3/>
2016-12-07 23:13:50 +08:00
2017-01-26 12:00:03 +08:00
可以跳过这个步骤，
2016-12-17 20:33:22 +08:00
2017-01-26 12:00:03 +08:00
如果以上编辑器一个都没安装，运行前先下载安装一个。< br / >
2017-01-30 22:17:18 +08:00
我的配置是Windows 7 + JDK 1.7.0_71 + ADT Bundle 20140702 + Android Studio 2.2 和 OSX EI Capitan +（ ） （ ） ，
2016-12-07 23:13:50 +08:00
#### ADT Bundle
2017-01-26 12:00:03 +08:00
1.导入< br / >
File > Import > Android > Existing Android Code Into Workspace > Next > Browse > 选择刚才解压路径下的APIJSON-Master/APIJSON(Android)/APIJSON(ADT) > Finish
2016-12-07 23:13:50 +08:00
2017-01-26 12:00:03 +08:00
2.运行< br / >
2016-12-07 23:13:50 +08:00
Run > Run As > Android Application
#### Android Studio
2017-01-26 12:00:03 +08:00
1.导入< br / >
2017-04-05 14:38:31 +08:00
Open an existing Android Studio project > 选择刚才解压路径下的APIJSON-Master/APIJSON(Android)/APIJSON(AndroidStudio)/APIJSONApp （ ）
2016-12-07 23:13:50 +08:00
2017-01-26 12:00:03 +08:00
2.运行< br / >
2016-12-07 23:13:50 +08:00
Run > Run app
2016-11-25 01:07:32 +08:00
2017-07-10 22:30:39 +08:00
### <h3 id="4.5">4.5 操作客户端App<h3/>
2016-11-25 01:07:32 +08:00
2017-01-26 12:00:03 +08:00
选择发送APIJSON请求并等待显示结果。< br / >
如果默认url不可用， ， ，
2016-11-25 01:07:32 +08:00
2017-07-10 22:53:08 +08:00
< br / >
< br / >
2017-07-10 22:30:39 +08:00
## <h2 id="5">5.其它<h2/>
2017-04-01 17:23:49 +08:00
2017-07-10 22:30:39 +08:00
### <h3 id="5.1">5.1 相关推荐<h3/>
2017-04-28 16:08:55 +08:00
[APIJSON, 让接口和文档见鬼去吧！ ](https://my.oschina.net/tommylemon/blog/805459 )
[仿QQ空间和微信朋友圈， ](https://my.oschina.net/tommylemon/blog/885787 )
2017-11-16 22:23:27 +08:00
[后端开挂:3行代码写出8个接口！ ](https://my.oschina.net/tommylemon/blog/1574430 )
2017-11-22 22:52:47 +08:00
[后端自动化版本管理， ！ ](https://my.oschina.net/tommylemon/blog/1576587 )
2017-04-28 16:08:55 +08:00
[3步创建APIJSON服务端新表及配置 ](https://my.oschina.net/tommylemon/blog/889074 )
2017-07-10 22:30:39 +08:00
### <h3 id="5.2">5.2 关于作者<h3/>
2017-03-06 22:40:53 +08:00
TommyLemon： < br / >
2017-09-05 18:10:28 +08:00
QQ群：
2017-06-11 23:52:49 +08:00
2017-09-05 18:10:28 +08:00
如果有什么问题或建议可以[提ISSUE](https://github.com/TommyLemon/APIJSON/issues)、加群或者[发我邮件](https://github.com/TommyLemon)，交流技术，分享经验。< br >
2017-06-11 23:52:49 +08:00
如果你解决了某些bug， ，
2017-03-06 22:40:53 +08:00
2017-07-10 22:30:39 +08:00
### <h3 id="5.3">5.3 下载试用客户端App<h3/>
2016-11-25 00:29:39 +08:00
2017-04-29 11:08:55 +08:00
仿微信朋友圈动态实战项目< br / >
2017-04-25 22:02:21 +08:00
[APIJSONApp.apk ](http://files.cnblogs.com/files/tommylemon/APIJSONApp.apk )
2016-11-25 19:51:19 +08:00
2017-04-29 11:08:55 +08:00
测试及自动生成代码工具< br / >
2017-04-25 20:58:17 +08:00
[APIJSONTest.apk ](http://files.cnblogs.com/files/tommylemon/APIJSONTest.apk )
2016-11-26 13:09:01 +08:00
2017-07-10 22:30:39 +08:00
### <h3 id="5.4">5.4 更新日志<h3/>
2017-01-26 14:21:55 +08:00
[https://github.com/TommyLemon/APIJSON/commits/master ](https://github.com/TommyLemon/APIJSON/commits/master )
2017-07-10 22:30:39 +08:00
### <h3 id="5.5">5.5 点Star支持我，
2016-11-26 13:09:01 +08:00
2017-01-26 14:17:14 +08:00
[https://github.com/TommyLemon/APIJSON ](https://github.com/TommyLemon/APIJSON )
