Skip to content

Commit 75d2652

Browse files
authored
Merge pull request #267 from wuseal/feature/128/api
feature/128/api
2 parents 57c1f82 + b8e91d9 commit 75d2652

File tree

28 files changed

+1726
-0
lines changed

28 files changed

+1726
-0
lines changed

api/LICENSE

Lines changed: 674 additions & 0 deletions
Large diffs are not rendered by default.

api/README.md

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# j2k
2+
3+
## API Documentation
4+
5+
This is a lightweight web service, (REST interface), which provides an easy way to access **`j2k`** data.
6+
The API works through simple commands, so there should not be a problem coding some nice applications.
7+
This API contains total **1** route(s)
8+
9+
10+
## API Endpoints
11+
12+
All the API endpoints return the same data structure as below
13+
14+
|Returned Key|Description|Example|
15+
|------------|-----------|-------|
16+
|error|The returned status for the API call, can be either 'true' or 'false'|true|
17+
|message|Either the error message or the successful message|OK|
18+
|data|If 'error' is returned as 'false' the API query results will be inside 'data'|data|
19+
20+
21+
**Success Response Format**
22+
23+
```json
24+
{
25+
"error": false,
26+
"message": "SUCCESS_MESSAGE",
27+
"data": {}
28+
}
29+
```
30+
31+
**Error Response Format**
32+
33+
```json
34+
{
35+
"error": true,
36+
"message": "ERROR_MESSAGE"
37+
}
38+
```
39+
40+
## Routes
41+
42+
43+
44+
#### 1 . /api/generate
45+
46+
- Method : **POST**
47+
- URL : [/api/generate](http://baseapiurlgoeshere.com/api/generate)
48+
- MockURL : [api/generate](http://theapache64.com/mock_api/get_json/j2k/api/generate?json=felis&class_name=habitant&is_skip_auth=true)
49+
50+
**Descriptions**
51+
52+
To generate kotlin code from given input JSON
53+
54+
55+
| Parameter | Required | Type | Default Value | Description |
56+
|-----------|----------|------|---------------|-------------|
57+
|json|true|String||JSON input string|
58+
|class_name|true|String||Class name of the output parent class|
59+
|annotation_lib|false|String|None|Annotation library to be used. Possible values are `None`,`NoneWithCamelCase`,`Gson`,`FastJson`,`Jackson`,`MoShi`,`LoganSquare`,`Custom`,`MoshiCodeGen`,`Serializable`|
60+
|class_suffix|false|String||Suffix to be added to every class name|
61+
|default_value_strategy|false|String|None|Possible values are `AvoidNull`, `AllowNull`, `None`|
62+
|indent|false|Integer|4|Output indent|
63+
|is_comments_enabled|false|Boolean|false||
64+
|is_create_annotation_only_when_needed_enabled|false|Boolean|false||
65+
|is_enable_var_properties|false|Boolean|false||
66+
|is_force_init_default_value_with_origin_json_value_enabled|false|Boolean|false||
67+
|is_force_primitive_type_non_nullable_enabled|false|Boolean|false||
68+
|is_inner_class_model_enabled|false|Boolean|false||
69+
|is_keep_annotation_on_class_androidx_enabled|false|Boolean|false||
70+
|is_keep_annotation_on_class_enabled|false|Boolean|false||
71+
|is_map_type_enabled|false|Boolean|false||
72+
|is_order_by_alphabetic_enabled|false|Boolean|false||
73+
|is_parcelable_support_enabled|false|Boolean|false||
74+
|is_property_and_annotation_in_same_line_enabled|false|Boolean|false||
75+
|package_name|false|String|||
76+
|parent_class_template|false|String|||
77+
|property_prefix|false|String|||
78+
|property_suffix|false|String|||
79+
|property_type_strategy|false|String|AutoDeterMineNullableOrNot|Possible values are `NotNullable`, `Nullable`,`AutoDeterMineNullableOrNot`.|
80+
81+
82+
**Response Body**
83+
```json
84+
{
85+
"data" : {
86+
"code" : "data class MyJsonClass(\n val name: String\n)"
87+
},
88+
"error" : false,
89+
"message" : "OK"
90+
}
91+
```
92+
93+
94+

api/build.gradle

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
buildscript {
2+
ext {
3+
kotlinVersion = '1.1.2'
4+
springBootVersion = '1.5.7.RELEASE'
5+
}
6+
repositories {
7+
mavenCentral()
8+
}
9+
dependencies {
10+
classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
11+
classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:${kotlinVersion}")
12+
classpath("org.jetbrains.kotlin:kotlin-allopen:${kotlinVersion}")
13+
classpath("org.jetbrains.kotlin:kotlin-noarg:$kotlinVersion")
14+
}
15+
}
16+
17+
apply plugin: 'kotlin'
18+
apply plugin: 'kotlin-spring'
19+
apply plugin: 'eclipse'
20+
apply plugin: 'org.springframework.boot'
21+
apply plugin: "kotlin-jpa"
22+
noArg {
23+
annotation("wu.seal.jsontokotlin.server.GenerateNoArgsConstruct")
24+
}
25+
group = 'wu.seal.tools.jsontokotlinclass'
26+
version = '1.0.2'
27+
sourceCompatibility = 1.8
28+
compileKotlin {
29+
kotlinOptions.jvmTarget = "1.8"
30+
}
31+
compileTestKotlin {
32+
kotlinOptions.jvmTarget = "1.8"
33+
}
34+
35+
36+
37+
repositories {
38+
mavenCentral()
39+
}
40+
41+
42+
dependencies {
43+
compile('org.springframework.boot:spring-boot-starter-web')
44+
compile("org.jetbrains.kotlin:kotlin-stdlib-jre8:${kotlinVersion}")
45+
compile("org.jetbrains.kotlin:kotlin-reflect:${kotlinVersion}")
46+
// JPA Data (We are going to use Repositories, Entities, Hibernate, etc...)
47+
compile 'org.springframework.boot:spring-boot-starter-data-jpa'
48+
49+
// Use MySQL Connector-J
50+
compile 'mysql:mysql-connector-java'
51+
compile files('libs/JsonToKotlinClassLibrary-3.5.1-alpha01.jar')
52+
testCompile("org.springframework.boot:spring-boot-starter-test")
53+
}
52.9 KB
Binary file not shown.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#Mon Sep 25 21:10:52 CST 2017
2+
distributionBase=GRADLE_USER_HOME
3+
distributionPath=wrapper/dists
4+
zipStoreBase=GRADLE_USER_HOME
5+
zipStorePath=wrapper/dists
6+
distributionUrl=https\://services.gradle.org/distributions/gradle-4.1-all.zip

api/gradlew

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,172 @@
1+
#!/usr/bin/env sh
2+
3+
##############################################################################
4+
##
5+
## Gradle start up script for UN*X
6+
##
7+
##############################################################################
8+
9+
# Attempt to set APP_HOME
10+
# Resolve links: $0 may be a link
11+
PRG="$0"
12+
# Need this for relative symlinks.
13+
while [ -h "$PRG" ] ; do
14+
ls=`ls -ld "$PRG"`
15+
link=`expr "$ls" : '.*-> \(.*\)$'`
16+
if expr "$link" : '/.*' > /dev/null; then
17+
PRG="$link"
18+
else
19+
PRG=`dirname "$PRG"`"/$link"
20+
fi
21+
done
22+
SAVED="`pwd`"
23+
cd "`dirname \"$PRG\"`/" >/dev/null
24+
APP_HOME="`pwd -P`"
25+
cd "$SAVED" >/dev/null
26+
27+
APP_NAME="Gradle"
28+
APP_BASE_NAME=`basename "$0"`
29+
30+
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31+
DEFAULT_JVM_OPTS=""
32+
33+
# Use the maximum available, or set MAX_FD != -1 to use that value.
34+
MAX_FD="maximum"
35+
36+
warn ( ) {
37+
echo "$*"
38+
}
39+
40+
die ( ) {
41+
echo
42+
echo "$*"
43+
echo
44+
exit 1
45+
}
46+
47+
# OS specific support (must be 'true' or 'false').
48+
cygwin=false
49+
msys=false
50+
darwin=false
51+
nonstop=false
52+
case "`uname`" in
53+
CYGWIN* )
54+
cygwin=true
55+
;;
56+
Darwin* )
57+
darwin=true
58+
;;
59+
MINGW* )
60+
msys=true
61+
;;
62+
NONSTOP* )
63+
nonstop=true
64+
;;
65+
esac
66+
67+
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68+
69+
# Determine the Java command to use to start the JVM.
70+
if [ -n "$JAVA_HOME" ] ; then
71+
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72+
# IBM's JDK on AIX uses strange locations for the executables
73+
JAVACMD="$JAVA_HOME/jre/sh/java"
74+
else
75+
JAVACMD="$JAVA_HOME/bin/java"
76+
fi
77+
if [ ! -x "$JAVACMD" ] ; then
78+
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79+
80+
Please set the JAVA_HOME variable in your environment to match the
81+
location of your Java installation."
82+
fi
83+
else
84+
JAVACMD="java"
85+
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86+
87+
Please set the JAVA_HOME variable in your environment to match the
88+
location of your Java installation."
89+
fi
90+
91+
# Increase the maximum file descriptors if we can.
92+
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93+
MAX_FD_LIMIT=`ulimit -H -n`
94+
if [ $? -eq 0 ] ; then
95+
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96+
MAX_FD="$MAX_FD_LIMIT"
97+
fi
98+
ulimit -n $MAX_FD
99+
if [ $? -ne 0 ] ; then
100+
warn "Could not set maximum file descriptor limit: $MAX_FD"
101+
fi
102+
else
103+
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104+
fi
105+
fi
106+
107+
# For Darwin, add options to specify how the application appears in the dock
108+
if $darwin; then
109+
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110+
fi
111+
112+
# For Cygwin, switch paths to Windows format before running java
113+
if $cygwin ; then
114+
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115+
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116+
JAVACMD=`cygpath --unix "$JAVACMD"`
117+
118+
# We build the pattern for arguments to be converted via cygpath
119+
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120+
SEP=""
121+
for dir in $ROOTDIRSRAW ; do
122+
ROOTDIRS="$ROOTDIRS$SEP$dir"
123+
SEP="|"
124+
done
125+
OURCYGPATTERN="(^($ROOTDIRS))"
126+
# Add a user-defined pattern to the cygpath arguments
127+
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128+
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129+
fi
130+
# Now convert the arguments - kludge to limit ourselves to /bin/sh
131+
i=0
132+
for arg in "$@" ; do
133+
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134+
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135+
136+
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137+
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138+
else
139+
eval `echo args$i`="\"$arg\""
140+
fi
141+
i=$((i+1))
142+
done
143+
case $i in
144+
(0) set -- ;;
145+
(1) set -- "$args0" ;;
146+
(2) set -- "$args0" "$args1" ;;
147+
(3) set -- "$args0" "$args1" "$args2" ;;
148+
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149+
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150+
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151+
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152+
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153+
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154+
esac
155+
fi
156+
157+
# Escape application args
158+
save ( ) {
159+
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160+
echo " "
161+
}
162+
APP_ARGS=$(save "$@")
163+
164+
# Collect all arguments for the java command, following the shell quoting and substitution rules
165+
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166+
167+
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168+
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169+
cd "$(dirname "$0")"
170+
fi
171+
172+
exec "$JAVACMD" "$@"

0 commit comments

Comments
 (0)