APIJSON/README.md

119 lines
6.2 KiB
Markdown
Raw Normal View History

2017-07-16 18:12:15 +08:00
# APIJSON
2018-01-14 21:20:43 +08:00
[![Java-Server API](https://img.shields.io/badge/Java.Server-1.7%2B-brightgreen.svg?style=flat)](https://github.com/TommyLemon/APIJSON/tree/master/APIJSON-Java-Server)
2018-07-07 18:24:57 +08:00
[![CSharp-Server API](https://img.shields.io/badge/CSharp.Server-2.1%2B-brightgreen.svg?style=flat)](https://github.com/liaozb/APIJSON.NET)
2018-06-03 16:03:04 +08:00
[![MySQL API](https://img.shields.io/badge/MySQL-5.7%2B-brightgreen.svg?style=flat)](https://github.com/TommyLemon/APIJSON/tree/master/table)
2017-12-06 00:18:48 +08:00
[![Android API](https://img.shields.io/badge/Android-4.0%2B-brightgreen.svg?style=flat)](https://github.com/TommyLemon/APIJSON/tree/master/APIJSON-Android)
[![iOS API](https://img.shields.io/badge/iOS-7%2B-brightgreen.svg?style=flat)](https://github.com/TommyLemon/APIJSON/tree/master/APIJSON-iOS)
2018-01-14 21:20:43 +08:00
[![JavaScrpit API](https://img.shields.io/badge/JavaScript-ES6%2B-brightgreen.svg?style=flat)](https://github.com/TommyLemon/APIJSON/tree/master/APIJSON-JavaScript)
2017-12-10 17:08:41 +08:00
[![Vue.js API](https://img.shields.io/badge/Vue.js-2.0%2B-brightgreen.svg?style=flat)](https://github.com/TommyLemon/APIJSON/tree/master/APIJSON-JavaScript/APIJSON-JS-Vue)
2017-12-12 23:47:51 +08:00
[![Python API](https://img.shields.io/badge/Python-2.7%2B-brightgreen.svg?style=flat)](https://github.com/TommyLemon/APIJSON/tree/master/APIJSON-Python)
2016-11-25 01:07:32 +08:00
2017-05-08 16:56:42 +08:00
2018-06-15 12:07:42 +08:00
[English](https://github.com/TommyLemon/APIJSON/blob/master/Document-English.md)   [通用文档](https://github.com/TommyLemon/APIJSON/blob/master/Document.md)   [视频教程](http://i.youku.com/apijson)   [在线工具](http://apijson.org)
2016-11-26 17:39:55 +08:00
2018-06-05 23:46:00 +08:00
![](https://raw.githubusercontent.com/TommyLemon/APIJSON/master/logo.png)
2017-04-01 16:49:48 +08:00
2017-12-03 02:32:03 +08:00
APIJSON是一种为API而生的JSON网络传输协议。<br />
2017-12-05 23:26:15 +08:00
为 简单的增删改查、复杂的查询、简单的事务操作 提供了完全自动化的API。<br />
2017-11-22 00:43:18 +08:00
能大幅降低开发和沟通成本,简化开发流程,缩短开发周期。<br />
2018-03-03 20:01:17 +08:00
适合中小型前后端分离的项目,尤其是互联网创业项目和企业自用项目。<br />
2016-11-24 22:54:11 +08:00
2017-12-06 01:18:13 +08:00
通过自动化API前端可以定制任何数据、任何结构<br />
2017-12-05 23:26:15 +08:00
大部分HTTP请求后端再也不用写接口了更不用写文档了<br />
前端再也不用和后端沟通接口或文档问题了!再也不会被文档各种错误坑了!<br />
后端再也不用为了兼容旧接口写新版接口和文档了!再也不会被前端随时随地没完没了地烦了!
2017-12-06 00:26:21 +08:00
2017-12-05 23:37:58 +08:00
### 特点功能
2017-04-23 18:22:37 +08:00
2017-12-06 00:00:17 +08:00
#### 在线解析
* 自动生成文档,清晰可读永远最新
* 自动生成请求代码支持Android和iOS
2018-06-15 23:59:08 +08:00
* 自动生成JavaBean文件一键下载
2018-04-05 18:18:56 +08:00
* 自动管理与测试接口用例,一键共享
2017-12-06 00:50:16 +08:00
* 自动校验与格式化JSON支持高亮和收展
2017-12-06 00:00:17 +08:00
2017-12-05 23:37:58 +08:00
#### 对于前端
2017-12-06 00:00:17 +08:00
* 不用再向后端催接口、求文档
2017-12-06 01:19:00 +08:00
* 数据和结构完全定制,要啥有啥
2017-12-06 00:51:38 +08:00
* 看请求知结果,所求即所得
2017-12-06 01:18:13 +08:00
* 可一次获取任何数据、任何结构
2017-12-05 23:26:15 +08:00
* 能去除重复数据,节省流量提高速度
2017-04-23 18:22:37 +08:00
2017-12-05 23:37:58 +08:00
#### 对于后端
2017-12-06 01:02:17 +08:00
* 提供通用接口大部分API不用再写
2017-12-06 00:00:17 +08:00
* 自动生成文档,不用再编写和维护
2018-07-18 10:47:00 +08:00
* 自动校验权限、自动管理版本、自动防SQL注入
2018-04-05 18:18:56 +08:00
* 开放API无需划分版本始终保持兼容
2017-12-06 00:00:17 +08:00
* 支持增删改查、模糊搜索、正则匹配、远程函数等
2017-12-05 23:37:58 +08:00
2017-12-06 00:41:42 +08:00
<br />
2016-11-25 00:29:39 +08:00
2018-06-05 23:40:28 +08:00
![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON_Auto_get.jpg)
![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON_Auto_code.jpg)
![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON_Auto_doc.jpg)
2017-12-06 00:40:38 +08:00
<br /><br />
2018-06-02 23:45:17 +08:00
[以下Gif图看起来比较卡实际在手机上App运行很流畅]
2017-12-06 00:40:38 +08:00
<br />
2018-06-05 23:43:19 +08:00
![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON_App_MomentList_Circle.gif)
![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON_App_Moment_Name.gif)
![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON_App_Moment_Comment.gif)
2017-12-06 00:26:21 +08:00
<br />
### 为什么要用APIJSON
[前后端9大痛点解析](https://github.com/TommyLemon/APIJSON/wiki)
2017-12-06 00:44:37 +08:00
### 快速上手
2017-12-10 16:27:48 +08:00
2017-12-10 16:30:14 +08:00
#### 1.后端部署
2018-01-16 22:26:08 +08:00
可以跳过这个步骤直接用APIJSON服务器IP地址 apijson.cn:8080 来测试接口。<br />
2017-12-11 22:15:49 +08:00
&nbsp; [APIJSON后端部署 - Java](https://github.com/TommyLemon/APIJSON/tree/master/APIJSON-Java-Server)<br />
2017-12-10 16:30:14 +08:00
#### 2.前端部署
2018-06-15 12:11:54 +08:00
可以跳过这个步骤,直接使用 [APIJSON在线工具](http://apijson.org/) 或 下载客户端App。<br />
2017-12-11 22:15:49 +08:00
&nbsp; [Android](https://github.com/TommyLemon/APIJSON/tree/master/APIJSON-Android) &nbsp;&nbsp; [iOS](https://github.com/TommyLemon/APIJSON/tree/master/APIJSON-iOS) &nbsp;&nbsp; [JavaScript](https://github.com/TommyLemon/APIJSON/tree/master/APIJSON-JavaScript)<br />
2017-07-02 18:00:16 +08:00
2017-12-11 21:29:46 +08:00
### 下载客户端App
2016-12-07 23:13:50 +08:00
2017-12-05 23:26:15 +08:00
仿微信朋友圈动态实战项目<br />
[APIJSONApp.apk](http://files.cnblogs.com/files/tommylemon/APIJSONApp.apk)
2016-12-07 23:13:50 +08:00
2017-12-05 23:26:15 +08:00
测试及自动生成代码工具<br />
[APIJSONTest.apk](http://files.cnblogs.com/files/tommylemon/APIJSONTest.apk)
2016-11-25 01:07:32 +08:00
2017-12-05 23:37:58 +08:00
### 关于作者
2017-12-05 23:26:15 +08:00
TommyLemon[https://github.com/TommyLemon](https://github.com/TommyLemon)<br />
2017-12-11 21:33:29 +08:00
QQ技术交流群607020115
2016-11-25 01:07:32 +08:00
2017-12-05 23:26:15 +08:00
如果有什么问题或建议可以[提ISSUE](https://github.com/TommyLemon/APIJSON/issues)、加群或者[发我邮件](https://github.com/TommyLemon),交流技术,分享经验。<br >
2017-12-06 00:37:02 +08:00
如果你解决了某些bug或者新增了一些功能欢迎[贡献代码](https://github.com/TommyLemon/APIJSON/pulls),感激不尽。
2017-07-10 22:53:08 +08:00
2017-04-01 17:23:49 +08:00
2017-12-05 23:37:58 +08:00
### 相关推荐
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
[后端自动化版本管理再也不用改URL了](https://my.oschina.net/tommylemon/blog/1576587)
2017-12-16 13:35:36 +08:00
[3步创建APIJSON后端新表及配置](https://my.oschina.net/tommylemon/blog/889074)
2017-04-28 16:08:55 +08:00
2017-06-11 23:52:49 +08:00
2018-07-04 22:07:38 +08:00
### 其它项目
[APIJSONAuto](https://github.com/TommyLemon/APIJSONAuto) 自动化接口管理工具。
2018-07-08 18:12:48 +08:00
[APIJSON.NET](https://github.com/liaozb/APIJSON.NET) 使用 C# 开发的服务端库。
2018-07-04 22:07:38 +08:00
2016-11-26 13:09:01 +08:00
2017-12-06 00:40:38 +08:00
### 持续更新
2017-01-26 14:21:55 +08:00
[https://github.com/TommyLemon/APIJSON/commits/master](https://github.com/TommyLemon/APIJSON/commits/master)
2017-12-05 23:38:47 +08:00
### 我要赞赏
2018-08-05 01:55:00 +08:00
创作不易,右上角点 ⭐Star 支持下吧,谢谢 ^_^ <br />
2017-01-26 14:17:14 +08:00
[https://github.com/TommyLemon/APIJSON](https://github.com/TommyLemon/APIJSON)
2017-12-05 23:26:15 +08:00
2017-12-05 23:28:26 +08:00