APIJSON

Java Android JavaScript

English Document

• 1.简介

• 2.对比传统方式

• 2.1 开发流程
• 2.2 客户端请求
• 2.3 服务端操作
• 2.4 客户端解析
• 2.5 对应不同需求的请求
• 2.6 对应不同请求的结果

• 3.对应关系总览

• 4.功能符

• 5.使用方法

• 5.1 下载解压
• 5.2 导入table
• 5.3 运行服务端工程
• 5.4 运行客户端工程
• 5.5 操作客户端App

• 6.其它

• 6.1 相关推荐
• 6.2 关于作者
• 6.3 下载试用
• 6.4 更新日志
• 6.5 Star&Fork

1.简介

APIJSON是一种JSON传输结构协议。

客户端可以定义任何JSON结构去向服务端发起请求，服务端就会返回对应结构的JSON字符串，所求即所得。
一次请求任意结构任意数据，方便灵活，不需要专门接口或多次请求。
支持增删改查、模糊搜索、远程函数调用等。还能去除重复数据，节省流量提高速度！

从此HTTP传输JSON数据没有接口，更不需要文档！
客户端再也不用和服务端沟通接口或文档问题了！再也不会被文档各种错误坑了！
服务端再也不用为了兼容旧版客户端写新版接口和文档了！再也不会被客户端随时随地没完没了地烦了！

举几个栗子:

查询用户

请求：

{
  "User":{
  }
}

点击这里测试

返回：

{
  "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"
    ]
  },
  "status":200,
  "message":"success"
}

查询用户列表

请求：

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

点击这里测试

返回：

{
  "[]":[
    {
      "User":{
        "id":38710,
        "name":"TommyLemon"
      }
    },
    {
      "User":{
        "id":70793,
        "name":"Strong"
      }
    },
    {
      "User":{
        "id":82001,
        "name":"Android"
      }
    }
  ],
  "status":200,
  "message":"success"
}

查询类似微信朋友圈的动态列表

请求：

{
  "[]":{                             //请求一个Array
    "page":0,                        //Array条件
    "count":2,
    "User":{                         //请求一个名为User的Table
      "sex":0,                       //Object条件
      "@column":"id,name,head"       //指定返回字段
    },
    "Moment":{
      "userId@":"/User/id"           //缺省依赖路径，从所处容器的父容器路径开始
    },
    "Comment[]":{                    //请求一个名为Comment的Array
      "count":2,
      "Comment":{
        "momentId@":"[]/Moment/id"   //完整依赖路径
      }
    }
  }
}

点击这里测试

返回：

{
  "[]":[
    {
      "User":{
        "id":38710,
        "name":"TommyLemon",
        "head":"http://static.oschina.net/uploads/user/1218/2437072_100.jpg?t=1461076033000"
      },
      "Moment":{
        "id":235,
        "userId":38710,
        "date":1486541171000,
        "pictureList":[
          "http://static.oschina.net/uploads/img/201604/22172508_mpwj.jpg"
        ]
      },
      "Comment[]":[
        {
          "Comment":{
            "id":160,
            "toId":0,
            "userId":82001,
            "momentId":235,
            "date":1488434166000,
            "content":"This is a Content...-160"
          }
        },
        {
          "Comment":{
            "id":163,
            "toId":0,
            "userId":82001,
            "momentId":235,
            "date":1488434166000,
            "content":"This is a Content...-163"
          }
        }
      ]
    },
    {
      "User":{
        "id":70793,
        "name":"Strong",
        "head":"http://static.oschina.net/uploads/user/585/1170143_50.jpg?t=1390226446000"
      },
      "Moment":{
        "id":12,
        "userId":70793,
        "date":1486541171000,
        "content":1111534034,
        "pictureList":[
          "http://static.oschina.net/uploads/img/201604/22172508_eGDi.jpg",
          "http://static.oschina.net/uploads/img/201604/22172507_rrZ5.jpg"
        ]
      },
      "Comment[]":[
        {
          "Comment":{
            "id":162,
            "toId":0,
            "userId":93793,
            "momentId":12,
            "date":1488776625000,
            "content":"This is a Content...-162"
          }
        },
        {
          "Comment":{
            "id":164,
            "toId":0,
            "userId":93793,
            "momentId":12,
            "date":1488776625000,
            "content":"This is a Content...-164"
          }
        }
      ]
    }
  ],
  "status":200,
  "message":"success"
}

2.对比传统RESTful方式

2.1 开发流程

2.2 客户端请求

2.3 服务端操作

2.4 客户端解析

2.5 客户端对应不同需求的请求

2.6 服务端对应不同请求的返回结果

1.base_url指基地址，一般是顶级域名，其它分支url都是在base_url后扩展。如base_url:http://www.google.com/ ，对应的GET分支url:http://www.google.com/get/ ，下同。
2.请求中的 / 需要转义。JSONRequest.java已经用URLEncoder.encode转义，不需要再写；但如果是浏览器或Postman等直接输入url/request，需要把request中的所有 / 都改成 %252F ，下同。
3.status，指返回结果中的状态码，200表示成功，其它都是错误码，值全部都是HTTP标准状态码。下同。
4.message，指返回结果中的状态信息，对成功结果或错误原因的详细说明。下同。
5.status和message总是在返回结果的同一层级成对出现。对所有请求的返回结果都会在最外层有一对总结式status和message。对非GET类请求，返回结果里面的每个JSONObject里都会有一对status和message说明这个JSONObject的状态。下同。
6.id等字段对应的值仅供说明，不一定是数据库里存在的，请求里用的是真实存在的值。下同。

3.请求方法、URL、Request、Response对应关系总览

1.TableName指要查询的table的名称字符串。第一个字符为大写字母，剩下的字符要符合英语字母、数字、下划线中的任何一种。对应的值为内部所传字段符合对应Table的JSONObject，结构是{...}
2."tag":tag 后面的tag是非GET、HEAD请求中匹配请求的JSON结构的key，一般是要查询的table的名称，由服务端Request表中指定。
3.非GET、HEAD请求，其对应的 方法、tag、结构 必须和 服务端Request表中指定的 一一对应，否则请求将不被通过。
4.POST_GET与GET、POST_HEAD与HEAD分别为同类方法，请求方式不同但返回结果相同。下同。
5.在HTTP通信中，GET、HEAD方法一般用HTTP GET请求，其它一般用HTTP POST请求。下同。

4.功能符

5.使用方法

5.1 下载后解压APIJSON工程

Clone or download > Download ZIP > 解压到一个路径并记住这个路径。

你可以跳过步骤5.2和步骤5.3，用我的服务器IP地址 139.196.140.118:8080 来测试服务端对客户端请求的返回结果。

5.2 导入MySQL table文件

服务端需要MySQL Server和MySQLWorkbench，没有安装的都先下载安装一个。
我的配置是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，其中系统和软件都是64位的。

启动MySQLWorkbench > 进入一个Connection > 点击Server菜单 > Data Import > 选择刚才解压路径下的APIJSON-Master/table > Start Import > 刷新SCHEMAS, 左下方sys/tables会出现添加的table。

5.3 用Eclipse for JavaEE或IntellIJ IDEA Ultimate运行服务端工程

如果以上编辑器一个都没安装，运行前先下载安装一个。
我的配置是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

Eclipse for JavaEE

1.导入
File > Import > Maven > Existing Maven Projects > Next > Browse > 选择刚才解压路径下的APIJSON-Master/APIJSON(Server)/APIJSON(Eclipse_JEE) > Finish

2.运行
Run > Run As > Java Application > 选择APIJSONApplication > OK

IntellIJ IDEA Ultimate

1.导入
Open > 选择刚才解压路径下的APIJSON-Master/APIJSON(Server)/APIJSON(Idea) > OK

2.运行
Run > Run APIJSONApplication

5.4 用ADT Bundle或Android Studio运行客户端工程

可以跳过这个步骤，直接下载下方提供的客户端App。

如果以上编辑器一个都没安装，运行前先下载安装一个。
我的配置是Windows 7 + JDK 1.7.0_71 + ADT Bundle 20140702 + Android Studio 2.2 和 OSX EI Capitan +（JDK 1.7.0_71 + ADT Bundle 20140702）+（JDK 1.8.0_91 + Android Studio 2.1.2），其中系统和软件都是64位的。

ADT Bundle

1.导入
File > Import > Android > Existing Android Code Into Workspace > Next > Browse > 选择刚才解压路径下的APIJSON-Master/APIJSON(Android)/APIJSON(ADT) > Finish

2.运行
Run > Run As > Android Application

Android Studio

1.导入
Open an existing Android Studio project > 选择刚才解压路径下的APIJSON-Master/APIJSON(Android)/APIJSON(AndroidStudio)/APIJSONApp （或APIJSONTest） > OK

2.运行
Run > Run app

5.5 操作客户端App

选择发送APIJSON请求并等待显示结果。
如果默认url不可用，修改为一个可用的，比如正在运行APIJSON服务端工程的电脑的IPV4地址，然后点击查询按钮重新请求。

6.其它

6.1 相关推荐

APIJSON, 让接口和文档见鬼去吧！

仿QQ空间和微信朋友圈，高解耦高复用高灵活

3步创建APIJSON服务端新表及配置

6.2 关于作者

TommyLemon：https://github.com/TommyLemon
如果有什么问题或建议可以发我邮件，交流技术，分享经验 ^_^

6.3 下载试用客户端App

仿微信朋友圈动态实战项目
APIJSONApp.apk

测试及自动生成代码工具
APIJSONTest.apk

6.4 更新日志

https://github.com/TommyLemon/APIJSON/commits/master

6.5 点Star支持我，点Fork研究它

https://github.com/TommyLemon/APIJSON