diff --git a/Document-English.md b/Documentation-English.md similarity index 100% rename from Document-English.md rename to Documentation-English.md diff --git a/README-English.md b/README-English.md index ba53a001e..3da3066d1 100644 --- a/README-English.md +++ b/README-English.md @@ -3,8 +3,7 @@ APIJSON -

🏆Gitee Most Valuable Project
🚀A JSON Transmission Protocol and an ORM Library for providing APIs and Documents automatically.

- +

🏆Gitee The Most Valuable Project in 2019
🚀APIJSON is a JSON based internet communication protocol exclusively for API design and an ORM library based on this protocal.

@@ -56,18 +55,24 @@ ##

1. About

-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. +APIJSON is a JSON based internet communication protocol exclusively for API design and an ORM library based on this protocal. APIJSON can largely simplifies the process of API development. It helps developers to build an automatic API with functions like CRUD, data search. + +By saving communication time between front-end and back-end developers and hours of API development work, it largely reduces costs of API development. + +APIJSON is recommanded to small to medium web applications that have decoupled front and back ends, such as startup company projects or company internal use projects. ### Features: -#### For getting data: -You can get any data by defining the specific information you want and send it to the server.
-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.
-It provides CRUD(read and write), Fuzzy Search, Remote Function Calls，etc. You can also save duplicate data, see request history,etc.
+#### For API developers: + +- APIJSON largely reduces API developers’ workload by reducing most API protocals design work and documentation work.
+- APIJSON supports automatic permission verification, version management and SQL injection prevention. The API has no version, so developers no longer need to worry about the update of API protocals or the derivative documentation update.
+- With these features, it saves communication time between front-end and back-end developers about the API design.
+ +#### For users: + +- You can get many resources and different forms of data by making just a single request While typical REST APIs require loading from multiple URLs. Being convenient and flexible, it saves sending multiple requests with multiple API endpoints.
+- It provides CRUD(read and write), Fuzzy Search, Remote Method Invocation (RMI), etc. Other features include saving duplicate data, checking request history, etc.
-#### For API design: -APIJSON largely reduces API developers' workload by reducing most api design and documentation work.
-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 .
-Server developers no longer need to worry about compatibility of APIs and documents with legacy apps. ### Examples: #### Get a User @@ -152,35 +157,35 @@ Response: [Test it online](http://apijson.cn/)
-![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON_Auto_get.jpg) +![](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_code.jpg)

##

2.Server-side deployment

- + 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. ###

2.1 Installing with Eclipse

####

2.1.1 prerequisites

- -Java Development Kit(JDK): 1.8 or above + +Java Development Kit(JDK): 1.8 or above [MAVEN](https://maven.apache.org/download.cgi): 3.0 or above Mysql / Oracle -[Eclipse Java EE IDE](https://www.eclipse.org/downloads/)for Web Developers.Version: Mars.1 Release (4.5.1) +[Eclipse Java EE IDE](https://www.eclipse.org/downloads/)for Web Developers.Version: Mars.1 Release (4.5.1) ####

2.1.2 Opening the project with Eclipse

- + Open Eclipse> *File > Import > Maven > Existing Maven Projects > Next > Browse > Select the path of the project you saved / APIJSON-Java-Server / APIJSONBoot > check pom.xml...apijson-demo > Finish* - + ####

2.1.3 Preparing the library used in demo

- + In the menu at the right, click libs, right click apijson-orm.jar,click add as library. Apply the same to the rest *.jar* files in libs. ####

2.1.4 Configuration

- + Open apijson.demo.server.DemoSQLConfig. In line 40-61, change return values of `getDBUri`,`getDBAccount`,`getDBPassword`,`getSchema` to your own database.

@@ -197,7 +202,7 @@ Open apijson.demo.server.DemoSQLConfig. In line 40-61, change return values of `
 	@Override
 	public String getDBPassword() {
   	//TODO: Change the return value to your own
-		return DATABASE_POSTGRESQL.equalsIgnoreCase(getDatabase()) ? null : "root"; 
+		return DATABASE_POSTGRESQL.equalsIgnoreCase(getDatabase()) ? null : "root";
 	}
 	@Override
 	public String getSchema() {
@@ -207,7 +212,7 @@ Open apijson.demo.server.DemoSQLConfig. In line 40-61, change return values of `
**Note**: Instead of this step, you can also [import your database](#2.2). - + ####

2.1.5 Running the application

In Eclipse, in the menu on the top, click *Run>Run As>Java Application>choose APIJSONApplication>OK* @@ -221,17 +226,17 @@ My config is Windows 7 + MySQL Community Server 5.7.16 + MySQLWorkbench 6.3.7 an Start *MySQLWorkbench > Enter a connection > Click Server menu > Data Import > Select the path of your .sql file > Start Import > Refresh SCHEMAS*. Now you should see tables are added successfully. ###

2.3 Installing with IntellIJ IDEA Ultimate

- + ####

2.3.1 Opening the project

*Open > Select the path of the project/APIJSON-Java-Server/APIJSONBoot > OK* -####

2.3.2 Preparing the library used in demo

- +####

2.3.2 Preparing the library used in demo

+ In libs, right-click *apijson-orm.jar >Add as Library>OK*. Apply this to all *.jar* files in libs. ####

2.3.3 Running the application

- + In the menu on the top: *Run > Run > Edit Configurations > + > Application > Configuration*
In *Main class* , choose *APIJSONApplication*;
In *Use classpath of module* , choose *apijson-demo*.
@@ -241,10 +246,10 @@ Click *Run* in the bottom.
-##

3. Client-side deployment

- +##

3. Client-side deployment

+ ###

3.1 For Android

- + Make sure you have either [ADT Bundle](https://stuff.mit.edu/afs/sipb/project/android/docs/sdk/installing/bundle.html) or [Android Studio](https://developer.android.com/studio) installed.
My config: Windows 7 + JDK 1.7.0_71 + ADT Bundle 20140702 + Android Studio 2.2 and OSX EI Capitan + (JDK 1.7.0_71 + ADT Bundle 20140702) + (JDK 1.8.0_91 + Android Studio 2.1.2). All the systems and software are 64 bit.
@@ -260,10 +265,10 @@ In the browser, send a request to the server. It should return with the result. If the default url is not available, change it to an available one, such as an IPV4 address that is running the server of the APIJSON project. Then click the request button again. ###

3.2 For iOS

- + Open xCode, then *APIJSON-Master/APIJSON-iOS/APIJSON-Swift > Open*
-In xCode, *Product > Run* +In xCode, *Product > Run* ###

3.3 For Javascript

@@ -271,8 +276,8 @@ 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.
You can also open it with Vue javascript framework. Click [here](https://vuejs.org/) to learn more. -##

4. Contributing

- +##

4. Contributing

+ 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 .
Fork the project and send a pull request.
@@ -280,22 +285,22 @@ Fork the project and send a pull request.
Please also ⭐Star the project!
-##

5. Versioning

- +##

5. Versioning

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

6. Auhtor

- +##

6. Auhtor

+ Check out the author's [github account](https://github.com/TommyLemon)to see more related projects.
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).
-##

7. Donating

- +##

7. Donating

+ 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.
@@ -325,4 +330,4 @@ If you like this projects and want to donate for maintainance cost, or want to b
- +