Update Document.md
This commit is contained in:
TommyLemon
GitHub
parent
1e7b901c0c
commit
778b1bcd0e
@ -338,12 +338,12 @@ https://github.com/Tencent/APIJSON
|
||||
------------ | ------------ | ------------ | ------------
|
||||
GET: <br > 普通获取数据，<br > 可用浏览器调试 | base_url/get/ | {<br > TableName:{<br > … <br > }<br >} <br > {…}内为限制条件<br ><br > 例如获取一个 id = 235 的 Moment：<br > [{<br > "Moment":{<br > "id":235<br > }<br >}](http://apijson.cn/api/?url=http%3A%2F%2Fapijson.cn%3A8080%2Fget&type=JSON&json={"Moment"%3A{"id"%3A235}}) <br > 后端校验通过后自动解析为 SQL 并执行：<br >`SELECT * FROM Moment WHERE id=235 LIMIT 1` | {<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 > 可用浏览器调试 | base_url/head/ | {<br > TableName:{<br > …<br > }<br > } <br > {…}内为限制条件 <br ><br > 例如获取一个 id = 38710 的 User 所发布的 Moment 总数：<br > [{<br > "Moment":{<br > "userId":38710<br > }<br >}](http://apijson.cn/api/?url=http%3A%2F%2Fapijson.cn%3A8080%2Fhead&type=JSON&json={"Moment"%3A{"userId"%3A38710}}) <br > 后端校验通过后自动解析为 SQL 并执行：<br >`SELECT count(*) FROM Moment WHERE userId=38710 LIMIT 1` | {<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 >}
|
||||
GETS: <br > 安全/私密获取数据，<br > 用于获取钱包等<br >对安全性要求高的数据 | base_url/gets/ | 最外层加一个 "tag":tag，例如 ["tag":"Privacy"](http://apijson.cn/api/?url=http%3A%2F%2Fapijson.cn%3A8080%2Fgets&type=JSON&json={"tag"%3A"Privacy","Privacy"%3A{"id"%3A82001}} )，其它同GET | 同GET
|
||||
GETS: <br > 安全/私密获取数据，<br > 用于获取钱包等<br >对安全性要求高的数据 | base_url/gets/ | 最外层加一个 "tag":tag，例如 ["tag":"Privacy"](http://apijson.cn/api/?url=http%3A%2F%2Fapijson.cn%3A8080%2Fgets&type=JSON&json={"tag"%3A"Privacy","Privacy"%3A{"id"%3A82001}})，其它同GET | 同GET
|
||||
HEADS: <br > 安全/私密获取数量，<br > 用于获取银行卡数量等<br >对安全性要求高的数据总数 | base_url/heads/ | 最外层加一个 "tag":tag，例如 ["tag":"Verify"](http://apijson.cn/api/?url=http%3A%2F%2Fapijson.cn%3A8080%2Fheads&type=JSON&json={"tag"%3A"Verify","Verify"%3A{"phone"%3A13000082001}})，其它同HEAD | 同HEAD
|
||||
POST: <br > 新增数据 | base_url/post/ | 单个： <br > {<br > TableName:{<br > …<br > },<br > "tag":tag<br >} <br > {…}中id由后端生成，不能传 <br ><br >例如当前登录用户 38710 发布一个新 Comment：<br >[{<br > "Comment":{<br > "momentId":12,<br > "content":"APIJSON,let interfaces and documents go to hell !" <br > },<br > "tag":"Comment"<br >}](http://apijson.cn/api?url=http%3A%2F%2Fapijson.cn%3A8080%2Fpost&type=JSON&json={"Comment":{"momentId":12,"content":"APIJSON,let%20interfaces%20and%20documents%20go%20to%20hell%20!"},"tag":"Comment"}) <br > 后端校验通过后自动解析为 SQL 并执行：<br >`INSERT INTO Comment(userId,momentId,content) VALUES(38710,12,'APIJSON,let interfaces and documents go to hell !')` <br > <br > 批量： <br > {<br > TableName\[]:\[{<br > …<br > }, {<br > …<br > }<br > …<br > ],<br > "tag":tag<br >} <br > {…}中id由后端生成，不能传 <br ><br >例如当前登录用户 82001 发布 2 个 Comment：<br >[{<br > "Comment[]":[{<br > "momentId":12,<br > "content":"APIJSON,let interfaces and documents go to hell !"<br > }, {<br > "momentId":15,<br > "content":"APIJSON is a JSON transmision protocol."<br > }],<br > "tag":"Comment:[]"<br >}](http://apijson.cn/api?url=http%3A%2F%2Fapijson.cn%3A8080%2Fpost&type=JSON&json={"Comment[]":[{"momentId":12,"content":"APIJSON,let%20interfaces%20and%20documents%20go%20to%20hell%20!"},{"momentId":15,"content":"APIJSON%20is%20a%20JSON%20transmision%20protocol."}],"tag":"Comment:[]"})<br > 后端校验通过后自动解析为 SQL 并执行：<br >`INSERT INTO Comment(userId,momentId,content) VALUES(82001,12,'APIJSON,let interfaces and documents go to hell !')`<br >`INSERT INTO Comment(userId,momentId,content) VALUES(82001,15,'APIJSON is a JSON transmision protocol.')` | 单个： <br > {<br > TableName:{<br > "code":200,<br > "msg":"success",<br > "id":38710<br > },<br > "code":200,<br > "msg":"success"<br >}<br >例如<br >{<br > "Comment":{<br > "code":200,<br > "msg":"success",<br > "id":120<br > },<br > "code":200,<br > "msg":"success"<br >} <br > <br > 批量： <br > {<br > TableName:{<br > "code":200,<br > "msg":"success",<br > "count":5,<br > "id[]":[1, 2, 3, 4, 5]<br > },<br > "code":200,<br > "msg":"success"<br >}<br >例如<br >{<br > "Comment":{<br > "code":200,<br > "msg":"success",<br > "count":2,<br > "id[]":\[1, 2]<br > },<br > "code":200,<br > "msg":"success"<br >}
|
||||
PUT: <br > 修改数据，<br > 只修改所传的字段 | base_url/put/ | {<br > TableName:{<br > "id":id,<br > …<br > },<br > "tag":tag<br >} <br > {…} 中 id 或 id{} 至少传一个 <br ><br >例如当前登录用户 82001 修改 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 >}](http://apijson.cn/api?url=http%3A%2F%2Fapijson.cn%3A8080%2Fput&type=JSON&json={"Moment":{"id":235,"content":"APIJSON,let%20interfaces%20and%20documents%20go%20to%20hell%20!"},"tag":"Moment"}) <br > 后端校验通过后自动解析为 SQL 并执行：<br >`UPDATE Moment SET content='APIJSON,let interfaces and documents go to hell !' WHERE id=235 AND userId=82001 LIMIT 1` <br ><br > 批量除了 id{}:\[] 也可类似批量 POST，只是每个 {...} 里面都必须有 id。<br >"tag":"Comment[]" 对应对象 "Comment":{"id{}":[1,2,3]}，表示指定记录全部统一设置；<br >"tag":"Comment:[]" 多了冒号，对应数组 "Comment[]":[{"id":1},{"id":2},{"id":3}]，表示每项单独设置 | 同POST
|
||||
DELETE: <br > 删除数据 | base_url/delete/ | {<br > TableName:{<br > "id":id<br > },<br > "tag":tag<br >} <br > {…} 中 id 或 id{} 至少传一个，一般只传 id 或 id{} <br ><br >例如当前登录用户 82001 批量删除 id = 100,110,120 的 Comment：<br >[{<br > "Comment":{<br > "id{}":[100,110,120]<br > },<br > "tag":"Comment[]"<br >}](http://apijson.cn/api?url=http%3A%2F%2Fapijson.cn%3A8080%2Fdelete&type=JSON&json={"Comment":{"id{}":[100,110,120]},"tag":"Comment[]"}) <br > 后端校验通过后自动解析为 SQL 并执行：<br >`DELETE FROM Comment WHERE id IN(100,110,120) AND userId=82001 LIMIT 3` | {<br > TableName:{<br > "code":200,<br > "msg":"success",<br > "id[]":[100,110,120]<br > "count":3<br > },<br > "code":200,<br > "msg":"success"<br >}<br >例如<br >{<br > "Comment":{<br > "code":200,<br > "msg":"success",<br > "id[]":[100,110,120],<br > "count":3<br > },<br > "code":200,<br > "msg":"success"<br >}
|
||||
|
||||
以上接口的简单形式: <br > base_url/{method}/{tag} | GET: 普通获取数据 <br > base_url/get/{tag} <br ><br > HEAD: 普通获取数量 <br > base_url/head/{tag} <br ><br > GETS: 安全/私密获取数据 <br > base_url/gets/{tag} <br ><br > HEADS: 安全/私密获取数量 <br > base_url/heads/{tag} <br ><br > POST: 新增数据 <br > base_url/post/{tag} <br ><br > PUT: 修改数据 base_url/put/{tag} <br ><br > DELETE: 删除数据 <br > base_url/delete/{tag} | 例如安全/私密获取一个 id = 82001 的 Privacy：<br > [base_url/gets/Privacy/ <br > {"id":82001}](http://apijson.cn/api/?url=http%3A%2F%2Fapijson.cn%3A8080%2Fgets%2FPrivacy&type=JSON&json={"id"%3A82001}) <br > 相当于 <br > [base_url/gets/ <br >{"tag":"Privacy","Privacy":{"id":82001}}](http://apijson.cn/api/?url=http%3A%2F%2Fapijson.cn%3A8080%2Fgets&type=JSON&json={"tag"%3A"Privacy","Privacy"%3A{"id"%3A82001}}) <br > <br > 例如批量修改 id = 114, 124 的 Comment 的 content：<br >[base_url/put/Comemnt[]/ <br > {<br > "id{}":[114,124],<br > "content":"test multi put"<br >}](http://apijson.cn/api?url=http%3A%2F%2Fapijson.cn%3A8080%2Fput%2FComment[]&type=JSON&json={"id{}"%3A[114,124],"content"%3A"test%20multi%20put"}) <br > 相当于 <br > [base_url/put/ <br > {<br > "tag":"Comment[]", <br > "Comment":{<br > "id{}":[114,124],<br > "content":"test multi put"<br > }<br >}](http://apijson.cn/api?url=http%3A%2F%2Fapijson.cn%3A8080%2Fput&type=JSON&json={"tag"%3A"Comment[]","Comment"%3A{"id{}"%3A[114,124],"content"%3A"test%20multi%20put"}}) | 同以上对应的方法
|
||||
|
||||
1.TableName指要查询的数据库表Table的名称字符串。第一个字符为大写字母，剩下的字符要符合英语字母、数字、下划线中的任何一种。对应的值的类型为JSONObject，结构是 {...}，里面放的是Table的字段(列名)。下同。<br >
|
||||
2."tag":tag 后面的tag是非GET、HEAD请求中匹配请求的JSON结构的标识，一般是要查询的Table的名称，由后端Request表中指定。下同。<br >
|
||||
|
||||
Loading…
Reference in New Issue
Block a user