Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fix typo
  • Loading branch information
ruoranw authored Jul 31, 2019
commit 1c3f6f61d70acc521177e296b5b1c71380b0abe6
37 changes: 16 additions & 21 deletions Document-English.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,19 +52,19 @@

<br />

<h2 id= "1">1. About <h2/>

## <h2 id= "1">1. About <h2/>

APIJSON is a JSON based application that largely simplify the process of back-end API development. It allows front-end users to get data with self-defined form.
APIJSON is a JSON based internet communication protocol and an ORM library that largely simplifies the process of back-end API development. It also allows users to get data more quickly with self-defined form and fewer endpoints requests.

### Features:
#### For getting data:
You can get any data by defining the specific information you want and send it to the server.<br />
You can get different types of data by making just one request to the server. It's very convenient and flexible, and dosen't require different API endpoints with multiple requests.<br />
It provides CRUD(read and write), Fuzzy Search, Remote Function Calls,etc. You can also save duplicate data and improve data transmission speed as well!<br />
It provides CRUD(read and write), Fuzzy Search, Remote Function Calls,etc. You can also save duplicate data, see request history,etc.<br />

#### For API design:
APIJSON largely reduces API developers' workload by reducing most api design and document writing!<br />
With APIJSON, client developers will no longer be suffered from possible errors in documents, and don't have to communicate with server developers about APIs or documents anymore.<br />
APIJSON largely reduces API developers' workload by reducing most api design and documentation work.<br />
With APIJSON, client developers will no longer be suffered from possible errors in documents, and it saves communication between server developers and client developers about APIs or documentations .<br />
Server developers no longer need to worry about compatibility of APIs and documents with legacy apps.

### Examples:
Expand Down Expand Up @@ -156,9 +156,8 @@ Response:
<p align="center" >


<h2 id="2">2.Server-side deployment<h2/>


## <h2 id="2">2.Server-side deployment<h2/>

You can use either Eclipse for JavaEE or IntelllJ IDEA Ultimate to make installation. For both, first download the project and save it to a path.

### <h3 id="2.1">2.1 Installing with Eclipse<h3/>
Expand Down Expand Up @@ -240,7 +239,7 @@ Click *Run* in the bottom.

<br />

<h2 id="3">3. Client-side deployment<h2/>
## <h2 id="3">3. Client-side deployment<h2/>

### <h3 id="3.1">3.1 For Android<h3/>

Expand Down Expand Up @@ -270,35 +269,31 @@ You can use either an IDE or text editor like sublime, Atom, etc. Webstorm is re
While using a text editor, you just open the .html file in the APIJSON-JS folder.<br/>
You can also open it with Vue javascript framework. Click [here](https://vuejs.org/) to learn more.

<h2 id="4">4. Contributing<h2/>

## <h2 id="4">4. Contributing<h2/>

We are always looking for more developers to help implementing new features, fix bugs, etc. Please have a look at the [open issues](https://github.com/APIJSON/APIJSON/issues) before opening a new one .<br />

Fork the project and send a pull request.<br />

Please also star the project!
Please also ⭐Star the project!
<br />

<h2 id="5">5. Versioning<h2/>

## <h2 id="5">5. Versioning<h2/>

See the latest version [here.](https://github.com/TommyLemon/APIJSON/commits/master)

<br />

<h2 id="6">6. Auhtor<h2/>

## <h2 id="6">6. Auhtor<h2/>

Check out the author's [github account!](https://github.com/TommyLemon)to see more related projects<br>
Check out the author's [github account](https://github.com/TommyLemon)to see more related projects.<br>

If you have any questions or suggestions, you can [create an issue](https://github.com/TommyLemon/APIJSON/issues) or [send me an e-mail](mailto:tommylemon@qq.com).

<br />

<h2 id="7">7. Donating<h2/>


## <h2 id="7">7. Donating<h2/>

If you like this projects and want to donate for maintainance cost, or want to buy me a coffee, you can scan Wechat QR code or QQ QR code below. <br />

<img src="https://raw.githubusercontent.com/TommyLemon/StaticResources/master/pay/WechatPay.JPG" width="240" ><img src="https://raw.githubusercontent.com/TommyLemon/StaticResources/master/pay/QQPay.JPG" width="240" >
Expand Down