|
52 | 52 |
|
53 | 53 | <br /> |
54 | 54 |
|
55 | | -<h2 id= "1">1. About <h2/> |
56 | | - |
| 55 | +## <h2 id= "1">1. About <h2/> |
57 | 56 |
|
58 | | -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. |
| 57 | +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. |
59 | 58 |
|
60 | 59 | ### Features: |
61 | 60 | #### For getting data: |
62 | 61 | You can get any data by defining the specific information you want and send it to the server.<br /> |
63 | 62 | 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 /> |
64 | | -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 /> |
| 63 | +It provides CRUD(read and write), Fuzzy Search, Remote Function Calls,etc. You can also save duplicate data, see request history,etc.<br /> |
| 64 | + |
65 | 65 | #### For API design: |
66 | | -APIJSON largely reduces API developers' workload by reducing most api design and document writing!<br /> |
67 | | -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 /> |
| 66 | +APIJSON largely reduces API developers' workload by reducing most api design and documentation work.<br /> |
| 67 | +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 /> |
68 | 68 | Server developers no longer need to worry about compatibility of APIs and documents with legacy apps. |
69 | 69 |
|
70 | 70 | ### Examples: |
@@ -156,9 +156,8 @@ Response: |
156 | 156 | <p align="center" > |
157 | 157 |
|
158 | 158 |
|
159 | | -<h2 id="2">2.Server-side deployment<h2/> |
160 | | - |
161 | | - |
| 159 | +## <h2 id="2">2.Server-side deployment<h2/> |
| 160 | + |
162 | 161 | 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. |
163 | 162 |
|
164 | 163 | ### <h3 id="2.1">2.1 Installing with Eclipse<h3/> |
@@ -240,7 +239,7 @@ Click *Run* in the bottom. |
240 | 239 |
|
241 | 240 | <br /> |
242 | 241 |
|
243 | | -<h2 id="3">3. Client-side deployment<h2/> |
| 242 | +## <h2 id="3">3. Client-side deployment<h2/> |
244 | 243 |
|
245 | 244 | ### <h3 id="3.1">3.1 For Android<h3/> |
246 | 245 |
|
@@ -270,35 +269,31 @@ You can use either an IDE or text editor like sublime, Atom, etc. Webstorm is re |
270 | 269 | While using a text editor, you just open the .html file in the APIJSON-JS folder.<br/> |
271 | 270 | You can also open it with Vue javascript framework. Click [here](https://vuejs.org/) to learn more. |
272 | 271 |
|
273 | | -<h2 id="4">4. Contributing<h2/> |
274 | | - |
| 272 | +## <h2 id="4">4. Contributing<h2/> |
275 | 273 |
|
276 | 274 | 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 /> |
277 | 275 |
|
278 | 276 | Fork the project and send a pull request.<br /> |
279 | 277 |
|
280 | | -Please also star the project! |
| 278 | +Please also ⭐Star the project! |
281 | 279 | <br /> |
282 | 280 |
|
283 | | -<h2 id="5">5. Versioning<h2/> |
284 | | - |
| 281 | +## <h2 id="5">5. Versioning<h2/> |
285 | 282 |
|
286 | 283 | See the latest version [here.](https://github.com/TommyLemon/APIJSON/commits/master) |
287 | 284 |
|
288 | 285 | <br /> |
289 | 286 |
|
290 | | -<h2 id="6">6. Auhtor<h2/> |
291 | | - |
| 287 | +## <h2 id="6">6. Auhtor<h2/> |
292 | 288 |
|
293 | | -Check out the author's [github account!](https://github.com/TommyLemon)to see more related projects<br> |
| 289 | +Check out the author's [github account](https://github.com/TommyLemon)to see more related projects.<br> |
294 | 290 |
|
295 | 291 | 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:[email protected]). |
296 | 292 |
|
297 | 293 | <br /> |
298 | 294 |
|
299 | | -<h2 id="7">7. Donating<h2/> |
300 | | - |
301 | | - |
| 295 | +## <h2 id="7">7. Donating<h2/> |
| 296 | + |
302 | 297 | 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 /> |
303 | 298 |
|
304 | 299 | <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" > |
|
0 commit comments