Compare commits
553 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c2597a585e | ||
|
|
4df779b4cc | ||
|
|
8b9d3fe588 | ||
|
|
4d4f4ad7d2 | ||
|
|
40467c0186 | ||
|
|
a2dc4080d5 | ||
|
|
76dced1209 | ||
|
|
1060b78622 | ||
|
|
23d3f336d5 | ||
|
|
5a70512c23 | ||
|
|
3c94b8605f | ||
|
|
e17311bd7e | ||
|
|
fecb5e2e61 | ||
|
|
79629d11ae | ||
|
|
6f1efabf94 | ||
|
|
393bbe10fd | ||
|
|
ab0ce79172 | ||
|
|
1311ce90b9 | ||
|
|
e19ed182ff | ||
|
|
8797e00321 | ||
|
|
1721a95e07 | ||
|
|
dac7550bcc | ||
|
|
44c0507b4e | ||
|
|
e69b8295dd | ||
|
|
e8cec2467b | ||
|
|
2cf2593e96 | ||
|
|
f1a1e52988 | ||
|
|
820d6dcb47 | ||
|
|
ea7643fc67 | ||
|
|
72b84a184e | ||
|
|
42b0cf8cf0 | ||
|
|
b0390b1f9a | ||
|
|
634598c5d4 | ||
|
|
e08de663d5 | ||
|
|
76347aa49e | ||
|
|
b0d6183de3 | ||
|
|
67fe8f70b3 | ||
|
|
8bcbb5fcfa | ||
|
|
972497a9a5 | ||
|
|
fbb98fb446 | ||
|
|
27a34c519b | ||
|
|
8ab88d95c8 | ||
|
|
ca60025907 | ||
|
|
184b0222a3 | ||
|
|
b6f4cec736 | ||
|
|
66fad7ea30 | ||
|
|
57fa494b95 | ||
|
|
5ec39bba49 | ||
|
|
9ecad42092 | ||
|
|
8914176db0 | ||
|
|
66757a39fd | ||
|
|
05818f8abf | ||
|
|
f6edc96b49 | ||
|
|
5818025e65 | ||
|
|
cd4a65c3d8 | ||
|
|
6f0e33c6d5 | ||
|
|
8a4ec35d47 | ||
|
|
319a8b68a8 | ||
|
|
109710b94e | ||
|
|
f02606abfc | ||
|
|
324f9a719c | ||
|
|
ac8332f1ed | ||
|
|
0cc153d896 | ||
|
|
9652d91723 | ||
|
|
dfab76f1c2 | ||
|
|
711886bb90 | ||
|
|
4f001e104f | ||
|
|
2befad39d0 | ||
|
|
223250693c | ||
|
|
8e6737fe79 | ||
|
|
667bd30dfd | ||
|
|
4a6c1a6e32 | ||
|
|
b365766cb4 | ||
|
|
7279daf5df | ||
|
|
5af951598d | ||
|
|
ffa27aa177 | ||
|
|
57a61ce839 | ||
|
|
a6576761c7 | ||
|
|
c427efaca3 | ||
|
|
ff2e3654c1 | ||
|
|
86b7577fd0 | ||
|
|
dd04f559d5 | ||
|
|
d828ab31f9 | ||
|
|
586596c5a1 | ||
|
|
00e723fbb8 | ||
|
|
5f844db4c5 | ||
|
|
fe93add209 | ||
|
|
753ad57059 | ||
|
|
c2a8d0d5eb | ||
|
|
36958d78aa | ||
|
|
704e20ef5c | ||
|
|
0104b8cfe8 | ||
|
|
43292024b6 | ||
|
|
ca8cc35004 | ||
|
|
f427e77b78 | ||
|
|
4d876c33a6 | ||
|
|
04f6239fd3 | ||
|
|
156f1ce880 | ||
|
|
836fcd6829 | ||
|
|
4a741acda2 | ||
|
|
857dd34992 | ||
|
|
84ad0ccaa7 | ||
|
|
128710cf50 | ||
|
|
26cd23941a | ||
|
|
d51684196d | ||
|
|
3f2f91f134 | ||
|
|
c62bcb02c2 | ||
|
|
de76eac12e | ||
|
|
dee68deb4d | ||
|
|
df4b6b8684 | ||
|
|
b49b7e01b9 | ||
|
|
12d3a5569a | ||
|
|
839a67aa18 | ||
|
|
c9a4e174db | ||
|
|
92adc61544 | ||
|
|
de24d5811c | ||
|
|
35e953d6b2 | ||
|
|
2728708af3 | ||
|
|
6f75fb6649 | ||
|
|
19dc822316 | ||
|
|
94d08b24d1 | ||
|
|
0a92457e41 | ||
|
|
03f19e7c25 | ||
|
|
4ddab7c8be | ||
|
|
101883f3b3 | ||
|
|
49da3d0fef | ||
|
|
6858dcd424 | ||
|
|
21e37a8cb3 | ||
|
|
7f116674b5 | ||
|
|
9c31fc416c | ||
|
|
0da081c0b4 | ||
|
|
d4973918f6 | ||
|
|
0ecda51555 | ||
|
|
de26a4fec3 | ||
|
|
f6481a7f21 | ||
|
|
f5291e3450 | ||
|
|
ddf3265d4b | ||
|
|
653420fa02 | ||
|
|
a98247adb4 | ||
|
|
f26ba312a7 | ||
|
|
447c4ca3c2 | ||
|
|
6189f710e1 | ||
|
|
5dcb0a3549 | ||
|
|
060f3f859b | ||
|
|
e465c7ff26 | ||
|
|
152083bfa6 | ||
|
|
5b2c34657e | ||
|
|
d0fba73012 | ||
|
|
1703b26626 | ||
|
|
08e445c579 | ||
|
|
da792f6fb8 | ||
|
|
dd606d65ad | ||
|
|
416aefdaf0 | ||
|
|
b725e7324f | ||
|
|
ffb53aac33 | ||
|
|
cbf1b50107 | ||
|
|
92438b20db | ||
|
|
4134a78185 | ||
|
|
ea8829a288 | ||
|
|
268815ac10 | ||
|
|
4ebfda1e94 | ||
|
|
6c7a9ad46e | ||
|
|
857ae5a3f7 | ||
|
|
b881d7f8b5 | ||
|
|
8014c4ba77 | ||
|
|
8443ddc2dc | ||
|
|
a6cf1b51c6 | ||
|
|
5065d4c744 | ||
|
|
7435dc8e1a | ||
|
|
4eb0ee49f6 | ||
|
|
b8984ca5f5 | ||
|
|
b2bceaece0 | ||
|
|
79446a84f1 | ||
|
|
cd023a99b5 | ||
|
|
a339e78135 | ||
|
|
1425414b4a | ||
|
|
a8e189408a | ||
|
|
fbb535d241 | ||
|
|
7d6fc09c24 | ||
|
|
00f62124af | ||
|
|
138be996db | ||
|
|
722b2b24b7 | ||
|
|
d90d68332f | ||
|
|
0470d984cc | ||
|
|
c001452abf | ||
|
|
b25378463c | ||
|
|
63d3a95529 | ||
|
|
1c1eb106d6 | ||
|
|
916d2515b0 | ||
|
|
caff7db0d4 | ||
|
|
85006b2c15 | ||
|
|
727c6c6467 | ||
|
|
12fc80c8b0 | ||
|
|
97ae3df30d | ||
|
|
3189043b7f | ||
|
|
9f01adfb25 | ||
|
|
5155e6510f | ||
|
|
37d99eb86f | ||
|
|
014e9354ce | ||
|
|
c8ecab6d78 | ||
|
|
2e7e10aaae | ||
|
|
9f197074ef | ||
|
|
5b054761cf | ||
|
|
be3ae6bd0d | ||
|
|
71980aafeb | ||
|
|
d1c20ed325 | ||
|
|
16f559cd70 | ||
|
|
d0dc6188cd | ||
|
|
e79f6c49a4 | ||
|
|
4ec11f8359 | ||
|
|
52c1780f79 | ||
|
|
c6becb9995 | ||
|
|
194efab1f6 | ||
|
|
34af7a4899 | ||
|
|
2b6c699828 | ||
|
|
e376b972fe | ||
|
|
445a04b9d6 | ||
|
|
99049d156a | ||
|
|
f8d331fc8b | ||
|
|
667a883fb0 | ||
|
|
2bd1719637 | ||
|
|
d9d62dec6b | ||
|
|
f3fdd45019 | ||
|
|
ded1cd6b06 | ||
|
|
854dcf48b2 | ||
|
|
0916fa38e2 | ||
|
|
c590f5102c | ||
|
|
9bda5b7941 | ||
|
|
ebba92368a | ||
|
|
2d17071c8c | ||
|
|
38d4bff7f4 | ||
|
|
fc5434cb3d | ||
|
|
3c0e545661 | ||
|
|
c0f758ba9b | ||
|
|
8a913d075d | ||
|
|
bbaf3a05b3 | ||
|
|
61c4f8861f | ||
|
|
1e7c51a2cb | ||
|
|
21620917f7 | ||
|
|
cc65055f3c | ||
|
|
71fab0ca94 | ||
|
|
b272e812d0 | ||
|
|
cb9092492f | ||
|
|
0a79020e59 | ||
|
|
4e4fa960b6 | ||
|
|
c28fddb4f6 | ||
|
|
e36587f61a | ||
|
|
40c53cf27b | ||
|
|
09c78a1cee | ||
|
|
b2d9e5ab73 | ||
|
|
a630c1a161 | ||
|
|
1771330890 | ||
|
|
02fed86851 | ||
|
|
46ae248056 | ||
|
|
5730a3be09 | ||
|
|
462df0032e | ||
|
|
d058a99874 | ||
|
|
2399cc25ca | ||
|
|
c7fe39bf21 | ||
|
|
a5bf4c64bb | ||
|
|
3fd97ea471 | ||
|
|
3dae4dd155 | ||
|
|
a510740fa3 | ||
|
|
91ba9e7fd3 | ||
|
|
f3056d316f | ||
|
|
0e9f556994 | ||
|
|
b9727c9275 | ||
|
|
d649fb0d87 | ||
|
|
1aa8221931 | ||
|
|
cbb541f1a3 | ||
|
|
8b215d7425 | ||
|
|
52ef344ba4 | ||
|
|
44eff18b3e | ||
|
|
a0c8d47369 | ||
|
|
d19a0020fd | ||
|
|
5494ad911e | ||
|
|
5ead0975c1 | ||
|
|
34cd890cd9 | ||
|
|
329756d664 | ||
|
|
8ebc4f603f | ||
|
|
07bcdf220d | ||
|
|
2f71a011c3 | ||
|
|
e6244fc3f8 | ||
|
|
9eb713cefb | ||
|
|
714c0aa8c9 | ||
|
|
91a0aeec9d | ||
|
|
a28c1d4efe | ||
|
|
a6af12ae06 | ||
|
|
910b2ff187 | ||
|
|
64adbfaab6 | ||
|
|
d60b8d4b83 | ||
|
|
684fc221b1 | ||
|
|
cf96642db5 | ||
|
|
ab6628b1ab | ||
|
|
06beab3865 | ||
|
|
bd77f4400f | ||
|
|
deebb2be9a | ||
|
|
22c6cab910 | ||
|
|
ea771c80d1 | ||
|
|
861b97c4ff | ||
|
|
b1ffe7cfc2 | ||
|
|
852ea15dc2 | ||
|
|
45768a5bba | ||
|
|
76b5a83511 | ||
|
|
c0d1da781f | ||
|
|
1a80a7a8eb | ||
|
|
cd66661026 | ||
|
|
b88e4eea56 | ||
|
|
f64a0d199d | ||
|
|
5f47f49cf4 | ||
|
|
7a0c8d81f6 | ||
|
|
427efca6f8 | ||
|
|
54546185ab | ||
|
|
493f045764 | ||
|
|
fd79e98ed7 | ||
|
|
40bf5762bb | ||
|
|
c291991236 | ||
|
|
7cb9b97bfb | ||
|
|
eddbd9610e | ||
|
|
a66ebec28f | ||
|
|
cdad18194e | ||
|
|
17f69b2bbc | ||
|
|
84176e5e27 | ||
|
|
67a3b924e8 | ||
|
|
84c86873fb | ||
|
|
2a486a2939 | ||
|
|
0550128e1d | ||
|
|
ff867c9ba4 | ||
|
|
c5fada0a62 | ||
|
|
7316ae0ce4 | ||
|
|
c8919e9844 | ||
|
|
4e340466de | ||
|
|
2fceda6f09 | ||
|
|
2aa29fde8a | ||
|
|
a76b7c545a | ||
|
|
8178bf1380 | ||
|
|
63ca190a32 | ||
|
|
836d9fbae7 | ||
|
|
9df1c73641 | ||
|
|
1899efd209 | ||
|
|
9d90766592 | ||
|
|
bd9d3ee4c3 | ||
|
|
20fac6ab26 | ||
|
|
5be5a7d8e3 | ||
|
|
35f0192ecb | ||
|
|
69949d6257 | ||
|
|
94ad45d2b0 | ||
|
|
c62f6085f7 | ||
|
|
2a300a2ef6 | ||
|
|
a77a0f281d | ||
|
|
d794cd989b | ||
|
|
60c687f3f8 | ||
|
|
8da5d3a770 | ||
|
|
ead3e0bc22 | ||
|
|
a0c1f20fc3 | ||
|
|
8e6586d4e4 | ||
|
|
b2f4229f70 | ||
|
|
2425074855 | ||
|
|
7d53a8aedb | ||
|
|
a16617880f | ||
|
|
650431b8ce | ||
|
|
a6654b65a9 | ||
|
|
4f15ea9ed7 | ||
|
|
aa34532b33 | ||
|
|
3fe711a3ba | ||
|
|
93e2175435 | ||
|
|
5c61006d11 | ||
|
|
6da74af830 | ||
|
|
93ba67c405 | ||
|
|
04fed3d4d5 | ||
|
|
1ead6614ba | ||
|
|
887e63464d | ||
|
|
47e5d5e56e | ||
|
|
c505c1e88e | ||
|
|
6a8c04c031 | ||
|
|
33f68a7f41 | ||
|
|
c5af8676e5 | ||
|
|
618898cb09 | ||
|
|
36bdcc57d9 | ||
|
|
eb418c07f5 | ||
|
|
9a265fbbc3 | ||
|
|
cf32d6cf29 | ||
|
|
9d216e3dc2 | ||
|
|
9d387b3e80 | ||
|
|
1e6be2f26d | ||
|
|
e56f824cd2 | ||
|
|
d38014f4b5 | ||
|
|
b331062fa6 | ||
|
|
88df748451 | ||
|
|
5384197bd1 | ||
|
|
2b5d4b7fe9 | ||
|
|
c15d074488 | ||
|
|
b0c3aa71b9 | ||
|
|
32d85ffb55 | ||
|
|
59fcd61738 | ||
|
|
7ce969882d | ||
|
|
ee70cdb94f | ||
|
|
f21fce7730 | ||
|
|
c426c7b341 | ||
|
|
1231d1e0c2 | ||
|
|
66073aebb8 | ||
|
|
882d9e5709 | ||
|
|
ba9ec45d9e | ||
|
|
f2787a41ae | ||
|
|
3469523225 | ||
|
|
1dc9a07cb9 | ||
|
|
a34807e5c9 | ||
|
|
85ef33a720 | ||
|
|
3163c077a1 | ||
|
|
fbb446875d | ||
|
|
e8cdcabffe | ||
|
|
832813d40a | ||
|
|
e2f28bca7d | ||
|
|
3ed894688c | ||
|
|
bb7422d755 | ||
|
|
b2f3f4a6c7 | ||
|
|
f21794a253 | ||
|
|
ffa96e56a5 | ||
|
|
38e50dfe77 | ||
|
|
1d3ec2d5a3 | ||
|
|
495751433b | ||
|
|
de7d73eae9 | ||
|
|
f825cf9613 | ||
|
|
6e32056c26 | ||
|
|
85bc2aa8f9 | ||
|
|
d56de83368 | ||
|
|
065e65a31c | ||
|
|
a68980bc76 | ||
|
|
90880a00f3 | ||
|
|
675dd762a8 | ||
|
|
7cdd436b10 | ||
|
|
a78126c551 | ||
|
|
f729bf15c3 | ||
|
|
ce129703f8 | ||
|
|
c99bba90a4 | ||
|
|
914a8ed5fb | ||
|
|
85b95c189e | ||
|
|
8722bdc8cb | ||
|
|
2ce724cdd0 | ||
|
|
922b6b8534 | ||
|
|
a05f4b2e29 | ||
|
|
e4e32f3f9f | ||
|
|
bf0b864c0d | ||
|
|
4948c8bea1 | ||
|
|
9397bf4255 | ||
|
|
a6d85d7b0c | ||
|
|
16371443e8 | ||
|
|
5738d86988 | ||
|
|
e1bf3fbe94 | ||
|
|
7ce98408f4 | ||
|
|
1a7b219c40 | ||
|
|
8a8e93f3ca | ||
|
|
1d95d9afc2 | ||
|
|
5b49187cb7 | ||
|
|
7b99565636 | ||
|
|
32980d1476 | ||
|
|
490a6d974f | ||
|
|
4e971817a2 | ||
|
|
f649553727 | ||
|
|
3576a80872 | ||
|
|
2bbb9ffd8e | ||
|
|
7d2acae537 | ||
|
|
1e68587097 | ||
|
|
71d77ce6ab | ||
|
|
de849b69d4 | ||
|
|
a8e84995ea | ||
|
|
edffd47067 | ||
|
|
cef474955e | ||
|
|
00dffe7b57 | ||
|
|
fea79bd4f9 | ||
|
|
fb5d30f700 | ||
|
|
ab15b393d0 | ||
|
|
7d1cf12c48 | ||
|
|
14d8acc385 | ||
|
|
e91d639d93 | ||
|
|
3671873349 | ||
|
|
f920a3e954 | ||
|
|
cb35f1f319 | ||
|
|
c8805f5018 | ||
|
|
cc04be6790 | ||
|
|
13eb453c2a | ||
|
|
d20dfa9027 | ||
|
|
38429152f2 | ||
|
|
cf382e9890 | ||
|
|
81b1846fcd | ||
|
|
7d48a65ec1 | ||
|
|
dc50cdff15 | ||
|
|
165e615698 | ||
|
|
2559bef4ce | ||
|
|
7847a74104 | ||
|
|
685596c213 | ||
|
|
20862d3ee4 | ||
|
|
2527792b58 | ||
|
|
d85d307e30 | ||
|
|
58e01e96e1 | ||
|
|
1b425b83b6 | ||
|
|
96d7195365 | ||
|
|
e14af63a4c | ||
|
|
925f1a1f81 | ||
|
|
1e5e2b20dd | ||
|
|
d209718987 | ||
|
|
31619b26c9 | ||
|
|
2277c7410b | ||
|
|
90d8b088d2 | ||
|
|
a5d9588a7d | ||
|
|
ff17b1d857 | ||
|
|
2a5bd83bb8 | ||
|
|
aa7800ba37 | ||
|
|
8a1a1a9d91 | ||
|
|
e7b59f8a2f | ||
|
|
8e75655346 | ||
|
|
e45498a1d7 | ||
|
|
5f838ca2b4 | ||
|
|
85e53ce89f | ||
|
|
51c1cd3fe5 | ||
|
|
29c7db1980 | ||
|
|
663323cd1e | ||
|
|
ab13a6ec0e | ||
|
|
d78eb490cb | ||
|
|
48e724cb4b | ||
|
|
0a3db6c013 | ||
|
|
a843fad921 | ||
|
|
de41e3b058 | ||
|
|
6bf3a5aab4 | ||
|
|
8d4bc8c0bc | ||
|
|
76df322bb4 | ||
|
|
36cdd3cebb | ||
|
|
ca4587cb29 | ||
|
|
ce958ba798 | ||
|
|
7c5c0fea8c | ||
|
|
5bc557a5d2 | ||
|
|
e23a649c17 | ||
|
|
a5300ceab5 | ||
|
|
fdb405e52a | ||
|
|
79cdd26ef0 | ||
|
|
87c24c8f31 | ||
|
|
6216165515 | ||
|
|
77640d21be | ||
|
|
57282f4933 | ||
|
|
1a12e0dc11 | ||
|
|
2b0317d1f6 | ||
|
|
8fce706f31 | ||
|
|
ae0f3ab31d | ||
|
|
34cb438757 | ||
|
|
8747ba2c1d | ||
|
|
bef4e3c735 | ||
|
|
6396b8fdb7 | ||
|
|
e27ba4304d | ||
|
|
4c86e73c4e | ||
|
|
9f9fa8c444 | ||
|
|
9647116572 | ||
|
|
736891fbdd | ||
|
|
edf9ba01bd |
4
.gitignore
vendored
@@ -1,4 +0,0 @@
|
||||
.idea
|
||||
*.iml
|
||||
.gradle
|
||||
build
|
||||
@@ -1,7 +0,0 @@
|
||||
language: java
|
||||
jdk:
|
||||
- oraclejdk7
|
||||
before_install:
|
||||
- chmod +x gradlew
|
||||
after_success:
|
||||
- ./gradlew jacocoTestReport coveralls
|
||||
BIN
1.3.1/images/Swagger2Markup.PNG
Normal file
|
After Width: | Height: | Size: 130 KiB |
BIN
1.3.1/images/Swagger2Markup_definitions.PNG
Normal file
|
After Width: | Height: | Size: 116 KiB |
BIN
1.3.1/images/confluence_petstore_screenshot_1024.png
Normal file
|
After Width: | Height: | Size: 133 KiB |
BIN
1.3.1/images/overview_extension_points.png
Normal file
|
After Width: | Height: | Size: 46 KiB |
BIN
1.3.1/images/titledSwagger.png
Normal file
|
After Width: | Height: | Size: 38 KiB |
BIN
1.3.1/images/untitledSwagger.png
Normal file
|
After Width: | Height: | Size: 35 KiB |
3120
1.3.1/index.html
Normal file
BIN
1.3.3/images/Swagger2Markup.PNG
Normal file
|
After Width: | Height: | Size: 130 KiB |
BIN
1.3.3/images/Swagger2Markup_definitions.PNG
Normal file
|
After Width: | Height: | Size: 116 KiB |
BIN
1.3.3/images/confluence_petstore_screenshot_1024.png
Normal file
|
After Width: | Height: | Size: 133 KiB |
BIN
1.3.3/images/overview_extension_points.png
Normal file
|
After Width: | Height: | Size: 46 KiB |
BIN
1.3.3/images/titledSwagger.png
Normal file
|
After Width: | Height: | Size: 38 KiB |
BIN
1.3.3/images/untitledSwagger.png
Normal file
|
After Width: | Height: | Size: 35 KiB |
3120
1.3.3/index.html
Normal file
BIN
1.3.4/images/Swagger2Markup.PNG
Normal file
|
After Width: | Height: | Size: 130 KiB |
BIN
1.3.4/images/Swagger2Markup_definitions.PNG
Normal file
|
After Width: | Height: | Size: 116 KiB |
BIN
1.3.4/images/confluence_petstore_screenshot_1024.png
Normal file
|
After Width: | Height: | Size: 133 KiB |
BIN
1.3.4/images/overview_extension_points.png
Normal file
|
After Width: | Height: | Size: 46 KiB |
BIN
1.3.4/images/titledSwagger.png
Normal file
|
After Width: | Height: | Size: 38 KiB |
BIN
1.3.4/images/untitledSwagger.png
Normal file
|
After Width: | Height: | Size: 35 KiB |
3206
1.3.4/index.html
Normal file
202
LICENSE.txt
@@ -1,202 +0,0 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright {yyyy} {name of copyright owner}
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
230
README.adoc
@@ -1,230 +0,0 @@
|
||||
= Swagger2Markup
|
||||
:author: Robert Winkler
|
||||
:version: 0.2.3
|
||||
:hardbreaks:
|
||||
|
||||
image:https://travis-ci.org/RobWin/swagger2markup.svg["Build Status", link="https://travis-ci.org/RobWin/swagger2markup"] image:https://coveralls.io/repos/RobWin/swagger2markup/badge.svg["Coverage Status", link="https://coveralls.io/r/RobWin/swagger2markup"] image:https://api.bintray.com/packages/robwin/maven/swagger2markup/images/download.svg[link="https://bintray.com/robwin/maven/swagger2markup/_latestVersion"] image:http://img.shields.io/badge/license-ASF2-blue.svg["Apache License 2", link="http://www.apache.org/licenses/LICENSE-2.0.txt"]
|
||||
image:https://badges.gitter.im/Join%20Chat.svg[link="https://gitter.im/RobWin/swagger2markup?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"]
|
||||
|
||||
== Overview
|
||||
|
||||
This project is a Swagger to Markup (AsciiDoc and Markdown) converter. The *Swagger2MarkupConverter* takes a swagger.json or swagger.yaml file as source and converts it into an AsciiDoc or Markdown document. The Swagger source file can be located locally or remotely accessible via HTTP. The Swagger2MarkupConverter supports the Swagger 1.2 and 2.0 specification. Internally it uses the _official_ https://github.com/swagger-api/swagger-parser[swagger-parser] and my https://github.com/RobWin/markup-document-builder[markup-document-builder].
|
||||
|
||||
The primary goal of this project is to simplify the documentation of RESTful APIs. The result is intended to be an easy-to-read, on- and offline user guide, comparable to https://developer.github.com/v3/[GitHub's API documentation].
|
||||
Swagger2Markup can be used together with https://github.com/spring-projects/spring-restdocs[spring-restdocs]. See <<integration-with-spring-restdocs, Integration with spring-restdocs>>.
|
||||
|
||||
The project requires at least JDK 7.
|
||||
|
||||
== Usage
|
||||
|
||||
=== Adding Swagger2Markup to your project
|
||||
The project is published in JCenter and Maven Central.
|
||||
|
||||
==== Maven
|
||||
|
||||
[source,xml]
|
||||
----
|
||||
<repositories>
|
||||
<repository>
|
||||
<snapshots>
|
||||
<enabled>false</enabled>
|
||||
</snapshots>
|
||||
<id>central</id>
|
||||
<name>bintray</name>
|
||||
<url>http://jcenter.bintray.com</url>
|
||||
</repository>
|
||||
</repositories>
|
||||
|
||||
<dependency>
|
||||
<groupId>io.github.robwin</groupId>
|
||||
<artifactId>swagger2markup</artifactId>
|
||||
<version>0.2.3</version>
|
||||
</dependency>
|
||||
----
|
||||
|
||||
==== Gradle
|
||||
|
||||
[source,groovy]
|
||||
----
|
||||
repositories {
|
||||
jcenter()
|
||||
}
|
||||
|
||||
compile "io.github.robwin:swagger2markup:0.2.3"
|
||||
----
|
||||
|
||||
=== Using Swagger2Markup
|
||||
|
||||
Using the Swagger2MarkupConverter is simple. For instance, you can generate your AsciiDoc/Markdown documentation using https://github.com/spring-projects/spring-boot[Spring Boot] and https://github.com/martypitt/swagger-springmvc[swagger-springmvc] as follows.
|
||||
See demo project https://github.com/RobWin/spring-swagger2markup-demo[spring-swagger2markup-demo].
|
||||
|
||||
[source,java]
|
||||
----
|
||||
@RunWith(SpringJUnit4ClassRunner.class)
|
||||
@SpringApplicationConfiguration(classes = SpringBootSwaggerConfig.class)
|
||||
@IntegrationTest
|
||||
@WebAppConfiguration
|
||||
public class Swagger2MarkupTest {
|
||||
|
||||
@Test
|
||||
public void convertSwaggerToMarkup() {
|
||||
//Remote Swagger source
|
||||
//Markdown
|
||||
Swagger2MarkupConverter.from("http://localhost:8080/api-docs").
|
||||
withMarkupLanguage(MarkupLanguage.MARKDOWN).build()
|
||||
.intoFolder("src/docs/markdown");
|
||||
|
||||
//Remote Swagger source
|
||||
//Default is AsciiDoc
|
||||
Swagger2MarkupConverter.from("http://localhost:8080/api-docs").build()
|
||||
.intoFolder("src/docs/asciidoc");
|
||||
|
||||
//Local Swagger source
|
||||
//Default is AsciiDoc
|
||||
File file = new File(Swagger2MarkupTest.class.getResource("/json/swagger.json").getFile());
|
||||
Swagger2MarkupConverter.from(file.getAbsolutePath()).build()
|
||||
.intoFolder("src/docs/asciidoc");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testSwagger2HtmlConversion() throws IOException {
|
||||
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/swagger.json").getFile());
|
||||
String asciiDoc = Swagger2MarkupConverter.from(file.getAbsolutePath()).build().asString();
|
||||
String path = "src/docs/asciidocAsString";
|
||||
Files.createDirectories(Paths.get(path));
|
||||
try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(path, "swagger.adoc"), StandardCharsets.UTF_8)){
|
||||
writer.write(asciiDoc); }
|
||||
String asciiDocAsHtml = Asciidoctor.Factory.create().convert(asciiDoc,
|
||||
OptionsBuilder.options().backend("html5").headerFooter(true).safe(SafeMode.UNSAFE).docType("book").attributes(AttributesBuilder.attributes()
|
||||
.tableOfContents(true).tableOfContents(Placement.LEFT).sectionNumbers(true).hardbreaks(true).setAnchors(true).attribute("sectlinks")));
|
||||
try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(path, "swagger.html"), StandardCharsets.UTF_8)){
|
||||
writer.write(asciiDocAsHtml);
|
||||
}
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
[source,java]
|
||||
----
|
||||
@SpringBootApplication
|
||||
@EnableSwagger
|
||||
public class SpringBootSwaggerConfig {
|
||||
|
||||
public static void main(String[] args) {
|
||||
SpringApplication.run(SpringBootTestConfig.class, args);
|
||||
}
|
||||
|
||||
@Autowired
|
||||
private SpringSwaggerConfig springSwaggerConfig;
|
||||
|
||||
@Bean
|
||||
public SwaggerSpringMvcPlugin customImplementation(){
|
||||
return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
|
||||
.apiInfo(apiInfo()).excludeAnnotations(Controller.class);
|
||||
}
|
||||
|
||||
private ApiInfo apiInfo() {
|
||||
ApiInfo apiInfo = new ApiInfo(
|
||||
"My Apps API Title",
|
||||
"My Apps API Description",
|
||||
"My Apps API terms of service",
|
||||
"My Apps API Contact Email",
|
||||
"My Apps API Licence Type",
|
||||
"My Apps API License URL"
|
||||
);
|
||||
return apiInfo;
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
You can generate your HTML5 and PDF documentation via https://github.com/asciidoctor/asciidoctorj[asciidoctorj] or even better via the https://github.com/asciidoctor/asciidoctor-gradle-plugin[asciidoctor-gradle-plugin] or https://github.com/aalmiray/markdown-gradle-plugin[markdown-gradle-plugin].
|
||||
You can also use https://github.com/tomchristie/mkdocs[MkDocs] and https://github.com/rtfd/readthedocs.org[ReadTheDocs] to publish your Markdown documentation.
|
||||
See http://spring-swagger2markup-demo.readthedocs.org/[ReadTheDocs-demo]
|
||||
|
||||
== Examples
|
||||
== Swagger source file
|
||||
image::images/swagger_json.PNG[swagger_json]
|
||||
|
||||
=== Generated AsciiDoc file
|
||||
image::images/asciidoc.PNG[asciidoc]
|
||||
|
||||
=== Generated Markdown file
|
||||
image::images/markdown.PNG[markdown]
|
||||
|
||||
=== Generated HTML using AsciidoctorJ
|
||||
image::images/asciidoc_html.PNG[asciidoc_html]
|
||||
|
||||
=== Generated HTML using Mkdocs
|
||||
image::images/mkdocs_html.PNG[mkdocs_html]
|
||||
|
||||
=== Generated PDF using AsciidoctorJ
|
||||
image::images/asciidoc_pdf.PNG[asciidoc_pdf]
|
||||
|
||||
|
||||
== Integration with spring-restdocs
|
||||
https://github.com/spring-projects/spring-restdocs[spring-restdocs] can be used together with Swagger2Markup.
|
||||
Swagger2Markup can include the generated examples from spring-restdocs into the generated AsciiDoc document.
|
||||
Currently it does not work for Markdown, since spring-restdocs generates only AsciiDoc files.
|
||||
|
||||
Let's say I have a Swagger-annotated Spring RestController method with an ApiOperation value: _"Create a quota"_
|
||||
|
||||
[source,java]
|
||||
----
|
||||
@ApiOperation(value = "Create a quota", notes = "Create a quota allows bla bla bla bla")
|
||||
public void createMailStorageQuota(@ApiParam(name = "MailStorageQuota",
|
||||
value = "MailStorageQuota", required = true) @RequestBody MailStorageQuota mailStorageQuota) {
|
||||
}
|
||||
----
|
||||
|
||||
I'm using spring-restdocs in combination with https://github.com/jayway/rest-assured to test the Controller.
|
||||
The target folder of the generated request and response example files must be _"create_a_quota"_ (similar to the value of the ApiOperation).
|
||||
|
||||
[source,java]
|
||||
----
|
||||
given().contentType(ContentType.XML).body(storageQuota).resultHandlers(document("create_a_quota")).
|
||||
when().put("/quotas").
|
||||
then().statusCode(204);
|
||||
----
|
||||
|
||||
The spring-restdocs output directory is configured as follows:
|
||||
|
||||
[source]
|
||||
----
|
||||
io.restdocumented.outputDir = docs/generated
|
||||
----
|
||||
|
||||
The Swagger2MarkupConverter must know the output directory of spring-restdocs.
|
||||
|
||||
[source,java]
|
||||
----
|
||||
Swagger2MarkupConverter.from("http://localhost:8080/api-docs").
|
||||
withExamples("docs/generated").build()
|
||||
.intoFolder("src/docs/asciidoc");
|
||||
----
|
||||
|
||||
The Swagger2MarkupConverter searches for a Swagger ApiOperation with value: _"Create a quota"_ in a folder called _"docs/generated/create_a_quota"_ and includes the _request.asciidoc_ and _response.asciidoc_ files, if they are available.
|
||||
|
||||
== Integration of JSON and XML Schema files.
|
||||
Swagger2Markup can also include JSON and XML Schema files into the generated document.
|
||||
|
||||
[source,java]
|
||||
----
|
||||
Swagger2MarkupConverter.from("http://localhost:8080/api-docs").
|
||||
withMarkupLanguage(MarkupLanguage.MARKDOWN).
|
||||
withExamples("docs/generated").withSchemas("docs/schemas").build()
|
||||
.intoFolder("src/docs/markdown");
|
||||
----
|
||||
|
||||
I create the Schemas files in Unit-Tests as follows:
|
||||
|
||||
[source,java]
|
||||
----
|
||||
RestDocumented restDocumented = RestDocumented.fromProperties();
|
||||
restDocumented.documentJsonSchema(MailStorageQuota.class, "docs/schemas");
|
||||
restDocumented.documentXmlSchema(MailStorageQuota.class, "docs/schemas");
|
||||
----
|
||||
|
||||
I will make RestDocumented public soon. RestDocumented creates a MailStorageQuota.xsd and MailStorageQuota.json file in the folder "docs/schemas".
|
||||
The Swagger2MarkupConverter will include the JSON and XML Schemas, if a Swagger Operation uses the MailStorageQuota class as Input or Output.
|
||||
|
||||
See example: http://spring-swagger2markup-demo.readthedocs.org/en/latest/generated/definitions/[ReadTheDocs-demo]
|
||||
@@ -1,13 +0,0 @@
|
||||
= Release Notes
|
||||
|
||||
== Version 0.1.0
|
||||
* Initial version with support for AsciiDoc and Markdown
|
||||
|
||||
== Version 0.2.0
|
||||
* This version is not downward compatible. This version supports includes of example files and JSON/XML Schema files. See documentation.
|
||||
|
||||
=== Version 0.2.1
|
||||
* Signed jar files and published in Maven Central
|
||||
|
||||
=== Version 0.2.1
|
||||
* Fixed wrong dependency version to io.github.robwin:markup-document-builder
|
||||
108
build.gradle
@@ -1,108 +0,0 @@
|
||||
buildscript {
|
||||
repositories {
|
||||
jcenter()
|
||||
mavenCentral()
|
||||
}
|
||||
dependencies {
|
||||
classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.2'
|
||||
classpath 'org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.6'
|
||||
classpath 'io.spring.gradle:dependency-management-plugin:0.4.0.RELEASE'
|
||||
classpath 'org.kt3k.gradle.plugin:coveralls-gradle-plugin:2.0.1'
|
||||
classpath 'org.asciidoctor:asciidoctorj:1.5.2'
|
||||
classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.0'
|
||||
}
|
||||
}
|
||||
description = 'swagger2markup Build'
|
||||
version = '0.2.3'
|
||||
group = 'io.github.robwin'
|
||||
|
||||
apply plugin: 'java'
|
||||
apply plugin: 'maven-publish'
|
||||
apply plugin: 'org.asciidoctor.convert'
|
||||
apply plugin: 'jacoco'
|
||||
apply plugin: 'com.github.kt3k.coveralls'
|
||||
apply plugin: 'io.spring.dependency-management'
|
||||
apply plugin: 'com.jfrog.bintray'
|
||||
apply from: 'gradle/publishing.gradle'
|
||||
|
||||
tasks.withType(JavaCompile) {
|
||||
sourceCompatibility = "1.7"
|
||||
targetCompatibility = "1.7"
|
||||
options.deprecation = true
|
||||
options.encoding = 'UTF-8'
|
||||
options.compilerArgs << "-Xlint:unchecked"
|
||||
}
|
||||
|
||||
repositories {
|
||||
jcenter()
|
||||
mavenCentral()
|
||||
mavenLocal()
|
||||
}
|
||||
|
||||
dependencies {
|
||||
compile 'io.github.robwin:markup-document-builder'
|
||||
compile 'io.swagger:swagger-compat-spec-parser'
|
||||
compile 'commons-collections:commons-collections'
|
||||
compile 'commons-io:commons-io'
|
||||
compile 'ch.qos.logback:logback-classic'
|
||||
testCompile 'junit:junit'
|
||||
testCompile 'org.asciidoctor:asciidoctorj:1.5.2'
|
||||
testCompile 'org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.6'
|
||||
}
|
||||
|
||||
dependencyManagement {
|
||||
dependencies {
|
||||
"io.github.robwin:markup-document-builder" "0.1.2"
|
||||
"io.swagger:swagger-compat-spec-parser" "1.0.0"
|
||||
"commons-collections:commons-collections" "3.2.1"
|
||||
"commons-io:commons-io" "2.4"
|
||||
"com.mangofactory:swagger-springmvc" "0.9.5"
|
||||
"com.jayway.restassured:spring-mock-mvc" "2.4.0"
|
||||
"ch.qos.logback:logback-classic" "1.1.2"
|
||||
"junit:junit" "4.11"
|
||||
}
|
||||
}
|
||||
|
||||
task sourcesJar(type: Jar, dependsOn: classes) {
|
||||
classifier = 'sources'
|
||||
from sourceSets.main.allSource
|
||||
}
|
||||
|
||||
task javadocJar(type: Jar, dependsOn: javadoc) {
|
||||
classifier = 'javadoc'
|
||||
from javadoc.destinationDir
|
||||
}
|
||||
|
||||
artifacts {
|
||||
archives sourcesJar
|
||||
archives javadocJar
|
||||
}
|
||||
|
||||
asciidoctor {
|
||||
backends = ['html5', 'pdf']
|
||||
attributes = [
|
||||
doctype: 'book',
|
||||
toc: 'left',
|
||||
toclevels: '2',
|
||||
numbered: ''
|
||||
]
|
||||
}
|
||||
|
||||
jacocoTestReport {
|
||||
reports {
|
||||
xml.enabled = true // coveralls plugin depends on xml format report
|
||||
html.enabled = true
|
||||
}
|
||||
}
|
||||
|
||||
tasks.coveralls {
|
||||
dependsOn 'check'
|
||||
}
|
||||
|
||||
tasks.asciidoctor {
|
||||
dependsOn 'check'
|
||||
}
|
||||
|
||||
task wrapper(type: Wrapper) {
|
||||
gradleVersion = '2.2.1'
|
||||
}
|
||||
@@ -1,100 +0,0 @@
|
||||
import java.text.SimpleDateFormat
|
||||
|
||||
Date buildTimeAndDate = new Date()
|
||||
ext {
|
||||
buildDate = new SimpleDateFormat('yyyy-MM-dd').format(buildTimeAndDate)
|
||||
buildTime = new SimpleDateFormat('HH:mm:ss.SSSZ').format(buildTimeAndDate)
|
||||
}
|
||||
|
||||
def projectArtifactId = 'swagger2markup'
|
||||
|
||||
jar {
|
||||
manifest {
|
||||
attributes(
|
||||
'Built-By': 'Robert Winkler',
|
||||
'Created-By': System.properties['java.version'] + " (" + System.properties['java.vendor'] + " " + System.properties['java.vm.version'] + ")",
|
||||
'Build-Date': project.buildDate,
|
||||
'Build-Time': project.buildTime,
|
||||
'Specification-Title': projectArtifactId,
|
||||
'Specification-Version': project.version,
|
||||
'Implementation-Title': projectArtifactId,
|
||||
'Implementation-Version': project.version
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
if (!project.hasProperty('bintrayUsername')) ext.bintrayUsername = ''
|
||||
if (!project.hasProperty('bintrayApiKey')) ext.bintrayApiKey = ''
|
||||
if (!project.hasProperty('gpgPassphrase')) ext.gpgPassphrase = ''
|
||||
if (!project.hasProperty('ossUser')) ext.ossUser = ''
|
||||
if (!project.hasProperty('ossPassword')) ext.ossPassword = ''
|
||||
|
||||
bintray {
|
||||
user = project.bintrayUsername
|
||||
key = project.bintrayApiKey
|
||||
dryRun = false //Whether to run this as dry-run, without deploying
|
||||
publish = true //If version should be auto published after an upload
|
||||
publications = ['mavenJava']
|
||||
pkg {
|
||||
repo = 'maven'
|
||||
name = 'swagger2markup'
|
||||
websiteUrl = 'https://github.com/RobWin/swagger2markup'
|
||||
issueTrackerUrl = 'https://github.com/RobWin/swagger2markup/issues'
|
||||
vcsUrl = 'https://github.com/RobWin/swagger2markup.git'
|
||||
desc = 'A Swagger to Markup (AsciiDoc and Markdown) converter.'
|
||||
licenses = ['Apache-2.0']
|
||||
version {
|
||||
vcsTag = project.version
|
||||
gpg {
|
||||
sign = true //Determines whether to GPG sign the files. The default is false
|
||||
passphrase = project.gpgPassphrase //Optional. The passphrase for GPG signing'
|
||||
}
|
||||
mavenCentralSync {
|
||||
sync = true //Optional (true by default). Determines whether to sync the version to Maven Central.
|
||||
user = ossUser //OSS user token
|
||||
password = ossPassword //OSS user password
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
publishing {
|
||||
publications {
|
||||
mavenJava(MavenPublication) {
|
||||
from components.java
|
||||
pom.withXml {
|
||||
def devs = ['RobWin': 'Robert Winkler']
|
||||
def root = asNode()
|
||||
|
||||
root.dependencies.'*'.findAll() {
|
||||
it.scope.text() == 'runtime' && project.configurations.compile.allDependencies.find { dep ->
|
||||
dep.name == it.artifactId.text()
|
||||
}
|
||||
}.each() {
|
||||
it.scope*.value = 'compile'
|
||||
}
|
||||
|
||||
root.appendNode('name', 'swagger2markup')
|
||||
root.appendNode('packaging', 'jar')
|
||||
root.appendNode('url', 'https://github.com/RobWin/swagger2markup')
|
||||
root.appendNode('description', 'A Swagger to Markup (AsciiDoc and Markdown) converter.')
|
||||
|
||||
def license = root.appendNode('licenses').appendNode('license')
|
||||
license.appendNode('name', 'Apache-2.0')
|
||||
license.appendNode('url', 'https://github.com/RobWin/swagger2markup/blob/master/LICENSE.txt')
|
||||
license.appendNode('distribution', 'repo')
|
||||
|
||||
root.appendNode('scm').appendNode('url', 'https://github.com/RobWin/swagger2markup.git')
|
||||
|
||||
def developers = root.appendNode('developers')
|
||||
devs.each {
|
||||
def d = developers.appendNode('developer')
|
||||
d.appendNode('id', it.key)
|
||||
d.appendNode('name', it.value)
|
||||
}
|
||||
}
|
||||
artifact sourcesJar
|
||||
artifact javadocJar
|
||||
}
|
||||
}
|
||||
}
|
||||
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
6
gradle/wrapper/gradle-wrapper.properties
vendored
@@ -1,6 +0,0 @@
|
||||
#Fri Feb 13 13:57:45 CET 2015
|
||||
distributionBase=GRADLE_USER_HOME
|
||||
distributionPath=wrapper/dists
|
||||
zipStoreBase=GRADLE_USER_HOME
|
||||
zipStorePath=wrapper/dists
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-2.2.1-all.zip
|
||||
164
gradlew
vendored
@@ -1,164 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
##############################################################################
|
||||
##
|
||||
## Gradle start up script for UN*X
|
||||
##
|
||||
##############################################################################
|
||||
|
||||
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||
DEFAULT_JVM_OPTS=""
|
||||
|
||||
APP_NAME="Gradle"
|
||||
APP_BASE_NAME=`basename "$0"`
|
||||
|
||||
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||
MAX_FD="maximum"
|
||||
|
||||
warn ( ) {
|
||||
echo "$*"
|
||||
}
|
||||
|
||||
die ( ) {
|
||||
echo
|
||||
echo "$*"
|
||||
echo
|
||||
exit 1
|
||||
}
|
||||
|
||||
# OS specific support (must be 'true' or 'false').
|
||||
cygwin=false
|
||||
msys=false
|
||||
darwin=false
|
||||
case "`uname`" in
|
||||
CYGWIN* )
|
||||
cygwin=true
|
||||
;;
|
||||
Darwin* )
|
||||
darwin=true
|
||||
;;
|
||||
MINGW* )
|
||||
msys=true
|
||||
;;
|
||||
esac
|
||||
|
||||
# For Cygwin, ensure paths are in UNIX format before anything is touched.
|
||||
if $cygwin ; then
|
||||
[ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
|
||||
fi
|
||||
|
||||
# Attempt to set APP_HOME
|
||||
# Resolve links: $0 may be a link
|
||||
PRG="$0"
|
||||
# Need this for relative symlinks.
|
||||
while [ -h "$PRG" ] ; do
|
||||
ls=`ls -ld "$PRG"`
|
||||
link=`expr "$ls" : '.*-> \(.*\)$'`
|
||||
if expr "$link" : '/.*' > /dev/null; then
|
||||
PRG="$link"
|
||||
else
|
||||
PRG=`dirname "$PRG"`"/$link"
|
||||
fi
|
||||
done
|
||||
SAVED="`pwd`"
|
||||
cd "`dirname \"$PRG\"`/" >&-
|
||||
APP_HOME="`pwd -P`"
|
||||
cd "$SAVED" >&-
|
||||
|
||||
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
|
||||
|
||||
# Determine the Java command to use to start the JVM.
|
||||
if [ -n "$JAVA_HOME" ] ; then
|
||||
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
|
||||
# IBM's JDK on AIX uses strange locations for the executables
|
||||
JAVACMD="$JAVA_HOME/jre/sh/java"
|
||||
else
|
||||
JAVACMD="$JAVA_HOME/bin/java"
|
||||
fi
|
||||
if [ ! -x "$JAVACMD" ] ; then
|
||||
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
|
||||
|
||||
Please set the JAVA_HOME variable in your environment to match the
|
||||
location of your Java installation."
|
||||
fi
|
||||
else
|
||||
JAVACMD="java"
|
||||
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||
|
||||
Please set the JAVA_HOME variable in your environment to match the
|
||||
location of your Java installation."
|
||||
fi
|
||||
|
||||
# Increase the maximum file descriptors if we can.
|
||||
if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then
|
||||
MAX_FD_LIMIT=`ulimit -H -n`
|
||||
if [ $? -eq 0 ] ; then
|
||||
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
|
||||
MAX_FD="$MAX_FD_LIMIT"
|
||||
fi
|
||||
ulimit -n $MAX_FD
|
||||
if [ $? -ne 0 ] ; then
|
||||
warn "Could not set maximum file descriptor limit: $MAX_FD"
|
||||
fi
|
||||
else
|
||||
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
|
||||
fi
|
||||
fi
|
||||
|
||||
# For Darwin, add options to specify how the application appears in the dock
|
||||
if $darwin; then
|
||||
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
|
||||
fi
|
||||
|
||||
# For Cygwin, switch paths to Windows format before running java
|
||||
if $cygwin ; then
|
||||
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
|
||||
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
|
||||
|
||||
# We build the pattern for arguments to be converted via cygpath
|
||||
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
|
||||
SEP=""
|
||||
for dir in $ROOTDIRSRAW ; do
|
||||
ROOTDIRS="$ROOTDIRS$SEP$dir"
|
||||
SEP="|"
|
||||
done
|
||||
OURCYGPATTERN="(^($ROOTDIRS))"
|
||||
# Add a user-defined pattern to the cygpath arguments
|
||||
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
|
||||
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
|
||||
fi
|
||||
# Now convert the arguments - kludge to limit ourselves to /bin/sh
|
||||
i=0
|
||||
for arg in "$@" ; do
|
||||
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
|
||||
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
|
||||
|
||||
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
|
||||
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
|
||||
else
|
||||
eval `echo args$i`="\"$arg\""
|
||||
fi
|
||||
i=$((i+1))
|
||||
done
|
||||
case $i in
|
||||
(0) set -- ;;
|
||||
(1) set -- "$args0" ;;
|
||||
(2) set -- "$args0" "$args1" ;;
|
||||
(3) set -- "$args0" "$args1" "$args2" ;;
|
||||
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
|
||||
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
|
||||
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
|
||||
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
|
||||
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
|
||||
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
|
||||
esac
|
||||
fi
|
||||
|
||||
# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
|
||||
function splitJvmOpts() {
|
||||
JVM_OPTS=("$@")
|
||||
}
|
||||
eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
|
||||
JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
|
||||
|
||||
exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"
|
||||
90
gradlew.bat
vendored
@@ -1,90 +0,0 @@
|
||||
@if "%DEBUG%" == "" @echo off
|
||||
@rem ##########################################################################
|
||||
@rem
|
||||
@rem Gradle startup script for Windows
|
||||
@rem
|
||||
@rem ##########################################################################
|
||||
|
||||
@rem Set local scope for the variables with windows NT shell
|
||||
if "%OS%"=="Windows_NT" setlocal
|
||||
|
||||
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||
set DEFAULT_JVM_OPTS=
|
||||
|
||||
set DIRNAME=%~dp0
|
||||
if "%DIRNAME%" == "" set DIRNAME=.
|
||||
set APP_BASE_NAME=%~n0
|
||||
set APP_HOME=%DIRNAME%
|
||||
|
||||
@rem Find java.exe
|
||||
if defined JAVA_HOME goto findJavaFromJavaHome
|
||||
|
||||
set JAVA_EXE=java.exe
|
||||
%JAVA_EXE% -version >NUL 2>&1
|
||||
if "%ERRORLEVEL%" == "0" goto init
|
||||
|
||||
echo.
|
||||
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||
echo.
|
||||
echo Please set the JAVA_HOME variable in your environment to match the
|
||||
echo location of your Java installation.
|
||||
|
||||
goto fail
|
||||
|
||||
:findJavaFromJavaHome
|
||||
set JAVA_HOME=%JAVA_HOME:"=%
|
||||
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
|
||||
|
||||
if exist "%JAVA_EXE%" goto init
|
||||
|
||||
echo.
|
||||
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
|
||||
echo.
|
||||
echo Please set the JAVA_HOME variable in your environment to match the
|
||||
echo location of your Java installation.
|
||||
|
||||
goto fail
|
||||
|
||||
:init
|
||||
@rem Get command-line arguments, handling Windowz variants
|
||||
|
||||
if not "%OS%" == "Windows_NT" goto win9xME_args
|
||||
if "%@eval[2+2]" == "4" goto 4NT_args
|
||||
|
||||
:win9xME_args
|
||||
@rem Slurp the command line arguments.
|
||||
set CMD_LINE_ARGS=
|
||||
set _SKIP=2
|
||||
|
||||
:win9xME_args_slurp
|
||||
if "x%~1" == "x" goto execute
|
||||
|
||||
set CMD_LINE_ARGS=%*
|
||||
goto execute
|
||||
|
||||
:4NT_args
|
||||
@rem Get arguments from the 4NT Shell from JP Software
|
||||
set CMD_LINE_ARGS=%$
|
||||
|
||||
:execute
|
||||
@rem Setup the command line
|
||||
|
||||
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
|
||||
|
||||
@rem Execute Gradle
|
||||
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
|
||||
|
||||
:end
|
||||
@rem End local scope for the variables with windows NT shell
|
||||
if "%ERRORLEVEL%"=="0" goto mainEnd
|
||||
|
||||
:fail
|
||||
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
|
||||
rem the _cmd.exe /c_ return code!
|
||||
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
|
||||
exit /b 1
|
||||
|
||||
:mainEnd
|
||||
if "%OS%"=="Windows_NT" endlocal
|
||||
|
||||
:omega
|
||||
|
Before Width: | Height: | Size: 44 KiB |
|
Before Width: | Height: | Size: 104 KiB |
|
Before Width: | Height: | Size: 95 KiB |
|
Before Width: | Height: | Size: 124 KiB |
|
Before Width: | Height: | Size: 29 KiB |
|
Before Width: | Height: | Size: 87 KiB |
|
Before Width: | Height: | Size: 26 KiB |
@@ -1 +0,0 @@
|
||||
rootProject.name = 'swagger2markup'
|
||||
@@ -1,55 +0,0 @@
|
||||
== Definitions
|
||||
=== User
|
||||
[options="header"]
|
||||
|===
|
||||
|Name|Description|Schema|Required
|
||||
|id||integer (int64)|false
|
||||
|username||string|false
|
||||
|firstName||string|false
|
||||
|lastName||string|false
|
||||
|email||string|false
|
||||
|password||string|false
|
||||
|phone||string|false
|
||||
|userStatus|User Status|integer (int32)|false
|
||||
|===
|
||||
|
||||
=== Category
|
||||
[options="header"]
|
||||
|===
|
||||
|Name|Description|Schema|Required
|
||||
|id||integer (int64)|false
|
||||
|name||string|false
|
||||
|===
|
||||
|
||||
=== Pet
|
||||
[options="header"]
|
||||
|===
|
||||
|Name|Description|Schema|Required
|
||||
|id||integer (int64)|false
|
||||
|category||<<Category>>|false
|
||||
|name||string|true
|
||||
|photoUrls||string array|true
|
||||
|tags||<<Tag>> array|false
|
||||
|status|pet status in the store|string|false
|
||||
|===
|
||||
|
||||
=== Tag
|
||||
[options="header"]
|
||||
|===
|
||||
|Name|Description|Schema|Required
|
||||
|id||integer (int64)|false
|
||||
|name||string|false
|
||||
|===
|
||||
|
||||
=== Order
|
||||
[options="header"]
|
||||
|===
|
||||
|Name|Description|Schema|Required
|
||||
|id||integer (int64)|false
|
||||
|petId||integer (int64)|false
|
||||
|quantity||integer (int32)|false
|
||||
|shipDate||string (date-time)|false
|
||||
|status|Order Status|string|false
|
||||
|complete||boolean|false
|
||||
|===
|
||||
|
||||
@@ -1,582 +0,0 @@
|
||||
= Swagger Petstore
|
||||
|
||||
This is a sample server Petstore server.
|
||||
|
||||
[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.
|
||||
|
||||
For this sample, you can use the api key `special-key` to test the authorization filters
|
||||
|
||||
Version: 1.0.0
|
||||
Contact: apiteam@wordnik.com
|
||||
License: Apache 2.0
|
||||
License URL: http://www.apache.org/licenses/LICENSE-2.0.html
|
||||
Terms of service: http://helloreverb.com/terms/
|
||||
|
||||
Host: petstore.swagger.wordnik.com
|
||||
BasePath: /v2
|
||||
Schemes: HTTP
|
||||
|
||||
== Paths
|
||||
=== Update an existing pet
|
||||
----
|
||||
PUT /pets
|
||||
----
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|BodyParameter|body|Pet object that needs to be added to the store|false|<<Pet>>
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|400|Invalid ID supplied|No Content
|
||||
|404|Pet not found|No Content
|
||||
|405|Validation exception|No Content
|
||||
|===
|
||||
|
||||
==== Consumes
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* pet
|
||||
|
||||
=== Add a new pet to the store
|
||||
----
|
||||
POST /pets
|
||||
----
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|BodyParameter|body|Pet object that needs to be added to the store|false|<<Pet>>
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|405|Invalid input|No Content
|
||||
|===
|
||||
|
||||
==== Consumes
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* pet
|
||||
|
||||
=== Finds Pets by status
|
||||
----
|
||||
GET /pets/findByStatus
|
||||
----
|
||||
|
||||
==== Description
|
||||
:hardbreaks:
|
||||
Multiple status values can be provided with comma seperated strings
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|QueryParameter|status|Status values that need to be considered for filter|false|multi string array
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|200|successful operation|<<Pet>> array
|
||||
|400|Invalid status value|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* pet
|
||||
|
||||
=== Finds Pets by tags
|
||||
----
|
||||
GET /pets/findByTags
|
||||
----
|
||||
|
||||
==== Description
|
||||
:hardbreaks:
|
||||
Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|QueryParameter|tags|Tags to filter by|false|multi string array
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|200|successful operation|<<Pet>> array
|
||||
|400|Invalid tag value|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* pet
|
||||
|
||||
=== Find pet by ID
|
||||
----
|
||||
GET /pets/{petId}
|
||||
----
|
||||
|
||||
==== Description
|
||||
:hardbreaks:
|
||||
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|PathParameter|petId|ID of pet that needs to be fetched|true|integer (int64)
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|200|successful operation|<<Pet>>
|
||||
|400|Invalid ID supplied|No Content
|
||||
|404|Pet not found|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* pet
|
||||
|
||||
=== Deletes a pet
|
||||
----
|
||||
DELETE /pets/{petId}
|
||||
----
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|HeaderParameter|api_key||true|string
|
||||
|PathParameter|petId|Pet id to delete|true|integer (int64)
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|400|Invalid pet value|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* pet
|
||||
|
||||
=== Updates a pet in the store with form data
|
||||
----
|
||||
POST /pets/{petId}
|
||||
----
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|PathParameter|petId|ID of pet that needs to be updated|true|string
|
||||
|FormDataParameter|name|Updated name of the pet|true|string
|
||||
|FormDataParameter|status|Updated status of the pet|true|string
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|405|Invalid input|No Content
|
||||
|===
|
||||
|
||||
==== Consumes
|
||||
|
||||
* application/x-www-form-urlencoded
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* pet
|
||||
|
||||
=== Place an order for a pet
|
||||
----
|
||||
POST /stores/order
|
||||
----
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|BodyParameter|body|order placed for purchasing the pet|false|<<Order>>
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|200|successful operation|<<Order>>
|
||||
|400|Invalid Order|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* store
|
||||
|
||||
=== Find purchase order by ID
|
||||
----
|
||||
GET /stores/order/{orderId}
|
||||
----
|
||||
|
||||
==== Description
|
||||
:hardbreaks:
|
||||
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|PathParameter|orderId|ID of pet that needs to be fetched|true|string
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|200|successful operation|<<Order>>
|
||||
|400|Invalid ID supplied|No Content
|
||||
|404|Order not found|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* store
|
||||
|
||||
=== Delete purchase order by ID
|
||||
----
|
||||
DELETE /stores/order/{orderId}
|
||||
----
|
||||
|
||||
==== Description
|
||||
:hardbreaks:
|
||||
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|PathParameter|orderId|ID of the order that needs to be deleted|true|string
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|400|Invalid ID supplied|No Content
|
||||
|404|Order not found|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* store
|
||||
|
||||
=== Create user
|
||||
----
|
||||
POST /users
|
||||
----
|
||||
|
||||
==== Description
|
||||
:hardbreaks:
|
||||
This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|BodyParameter|body|Created user object|false|<<User>>
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|default|successful operation|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* user
|
||||
|
||||
=== Creates list of users with given input array
|
||||
----
|
||||
POST /users/createWithArray
|
||||
----
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|BodyParameter|body|List of user object|false|<<User>> array
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|default|successful operation|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* user
|
||||
|
||||
=== Creates list of users with given input array
|
||||
----
|
||||
POST /users/createWithList
|
||||
----
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|BodyParameter|body|List of user object|false|<<User>> array
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|default|successful operation|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* user
|
||||
|
||||
=== Logs user into the system
|
||||
----
|
||||
GET /users/login
|
||||
----
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|QueryParameter|username|The user name for login|false|string
|
||||
|QueryParameter|password|The password for login in clear text|false|string
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|200|successful operation|string
|
||||
|400|Invalid username/password supplied|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* user
|
||||
|
||||
=== Logs out current logged in user session
|
||||
----
|
||||
GET /users/logout
|
||||
----
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|default|successful operation|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* user
|
||||
|
||||
=== Get user by user name
|
||||
----
|
||||
GET /users/{username}
|
||||
----
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|PathParameter|username|The name that needs to be fetched. Use user1 for testing.|true|string
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|200|successful operation|<<User>>
|
||||
|400|Invalid username supplied|No Content
|
||||
|404|User not found|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* user
|
||||
|
||||
=== Updated user
|
||||
----
|
||||
PUT /users/{username}
|
||||
----
|
||||
|
||||
==== Description
|
||||
:hardbreaks:
|
||||
This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|PathParameter|username|name that need to be deleted|true|string
|
||||
|BodyParameter|body|Updated user object|false|<<User>>
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|400|Invalid user supplied|No Content
|
||||
|404|User not found|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* user
|
||||
|
||||
=== Delete user
|
||||
----
|
||||
DELETE /users/{username}
|
||||
----
|
||||
|
||||
==== Description
|
||||
:hardbreaks:
|
||||
This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|PathParameter|username|The name that needs to be deleted|true|string
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|400|Invalid username supplied|No Content
|
||||
|404|User not found|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* user
|
||||
|
||||
@@ -1,637 +0,0 @@
|
||||
= Swagger Petstore
|
||||
|
||||
This is a sample server Petstore server.
|
||||
|
||||
[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.
|
||||
|
||||
For this sample, you can use the api key `special-key` to test the authorization filters
|
||||
|
||||
Version: 1.0.0
|
||||
Contact: apiteam@wordnik.com
|
||||
License: Apache 2.0
|
||||
License URL: http://www.apache.org/licenses/LICENSE-2.0.html
|
||||
Terms of service: http://helloreverb.com/terms/
|
||||
|
||||
Host: petstore.swagger.wordnik.com
|
||||
BasePath: /v2
|
||||
Schemes: HTTP
|
||||
|
||||
== Paths
|
||||
=== Update an existing pet
|
||||
----
|
||||
PUT /pets
|
||||
----
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|BodyParameter|body|Pet object that needs to be added to the store|false|<<Pet>>
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|400|Invalid ID supplied|No Content
|
||||
|404|Pet not found|No Content
|
||||
|405|Validation exception|No Content
|
||||
|===
|
||||
|
||||
==== Consumes
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* pet
|
||||
|
||||
=== Add a new pet to the store
|
||||
----
|
||||
POST /pets
|
||||
----
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|BodyParameter|body|Pet object that needs to be added to the store|false|<<Pet>>
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|405|Invalid input|No Content
|
||||
|===
|
||||
|
||||
==== Consumes
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* pet
|
||||
|
||||
=== Finds Pets by status
|
||||
----
|
||||
GET /pets/findByStatus
|
||||
----
|
||||
|
||||
==== Description
|
||||
:hardbreaks:
|
||||
Multiple status values can be provided with comma seperated strings
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|QueryParameter|status|Status values that need to be considered for filter|false|multi string array
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|200|successful operation|<<Pet>> array
|
||||
|400|Invalid status value|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* pet
|
||||
|
||||
=== Finds Pets by tags
|
||||
----
|
||||
GET /pets/findByTags
|
||||
----
|
||||
|
||||
==== Description
|
||||
:hardbreaks:
|
||||
Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|QueryParameter|tags|Tags to filter by|false|multi string array
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|200|successful operation|<<Pet>> array
|
||||
|400|Invalid tag value|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* pet
|
||||
|
||||
=== Find pet by ID
|
||||
----
|
||||
GET /pets/{petId}
|
||||
----
|
||||
|
||||
==== Description
|
||||
:hardbreaks:
|
||||
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|PathParameter|petId|ID of pet that needs to be fetched|true|integer (int64)
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|200|successful operation|<<Pet>>
|
||||
|400|Invalid ID supplied|No Content
|
||||
|404|Pet not found|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* pet
|
||||
|
||||
=== Deletes a pet
|
||||
----
|
||||
DELETE /pets/{petId}
|
||||
----
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|HeaderParameter|api_key||true|string
|
||||
|PathParameter|petId|Pet id to delete|true|integer (int64)
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|400|Invalid pet value|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* pet
|
||||
|
||||
=== Updates a pet in the store with form data
|
||||
----
|
||||
POST /pets/{petId}
|
||||
----
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|PathParameter|petId|ID of pet that needs to be updated|true|string
|
||||
|FormDataParameter|name|Updated name of the pet|true|string
|
||||
|FormDataParameter|status|Updated status of the pet|true|string
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|405|Invalid input|No Content
|
||||
|===
|
||||
|
||||
==== Consumes
|
||||
|
||||
* application/x-www-form-urlencoded
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* pet
|
||||
|
||||
=== Place an order for a pet
|
||||
----
|
||||
POST /stores/order
|
||||
----
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|BodyParameter|body|order placed for purchasing the pet|false|<<Order>>
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|200|successful operation|<<Order>>
|
||||
|400|Invalid Order|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* store
|
||||
|
||||
=== Find purchase order by ID
|
||||
----
|
||||
GET /stores/order/{orderId}
|
||||
----
|
||||
|
||||
==== Description
|
||||
:hardbreaks:
|
||||
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|PathParameter|orderId|ID of pet that needs to be fetched|true|string
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|200|successful operation|<<Order>>
|
||||
|400|Invalid ID supplied|No Content
|
||||
|404|Order not found|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* store
|
||||
|
||||
=== Delete purchase order by ID
|
||||
----
|
||||
DELETE /stores/order/{orderId}
|
||||
----
|
||||
|
||||
==== Description
|
||||
:hardbreaks:
|
||||
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|PathParameter|orderId|ID of the order that needs to be deleted|true|string
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|400|Invalid ID supplied|No Content
|
||||
|404|Order not found|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* store
|
||||
|
||||
=== Create user
|
||||
----
|
||||
POST /users
|
||||
----
|
||||
|
||||
==== Description
|
||||
:hardbreaks:
|
||||
This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|BodyParameter|body|Created user object|false|<<User>>
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|default|successful operation|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* user
|
||||
|
||||
=== Creates list of users with given input array
|
||||
----
|
||||
POST /users/createWithArray
|
||||
----
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|BodyParameter|body|List of user object|false|<<User>> array
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|default|successful operation|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* user
|
||||
|
||||
=== Creates list of users with given input array
|
||||
----
|
||||
POST /users/createWithList
|
||||
----
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|BodyParameter|body|List of user object|false|<<User>> array
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|default|successful operation|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* user
|
||||
|
||||
=== Logs user into the system
|
||||
----
|
||||
GET /users/login
|
||||
----
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|QueryParameter|username|The user name for login|false|string
|
||||
|QueryParameter|password|The password for login in clear text|false|string
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|200|successful operation|string
|
||||
|400|Invalid username/password supplied|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* user
|
||||
|
||||
=== Logs out current logged in user session
|
||||
----
|
||||
GET /users/logout
|
||||
----
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|default|successful operation|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* user
|
||||
|
||||
=== Get user by user name
|
||||
----
|
||||
GET /users/{username}
|
||||
----
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|PathParameter|username|The name that needs to be fetched. Use user1 for testing.|true|string
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|200|successful operation|<<User>>
|
||||
|400|Invalid username supplied|No Content
|
||||
|404|User not found|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* user
|
||||
|
||||
=== Updated user
|
||||
----
|
||||
PUT /users/{username}
|
||||
----
|
||||
|
||||
==== Description
|
||||
:hardbreaks:
|
||||
This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|PathParameter|username|name that need to be deleted|true|string
|
||||
|BodyParameter|body|Updated user object|false|<<User>>
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|400|Invalid user supplied|No Content
|
||||
|404|User not found|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* user
|
||||
|
||||
=== Delete user
|
||||
----
|
||||
DELETE /users/{username}
|
||||
----
|
||||
|
||||
==== Description
|
||||
:hardbreaks:
|
||||
This can only be done by the logged in user.
|
||||
|
||||
==== Parameters
|
||||
[options="header"]
|
||||
|===
|
||||
|Type|Name|Description|Required|Schema
|
||||
|PathParameter|username|The name that needs to be deleted|true|string
|
||||
|===
|
||||
|
||||
==== Responses
|
||||
[options="header"]
|
||||
|===
|
||||
|HTTP Code|Description|Schema
|
||||
|400|Invalid username supplied|No Content
|
||||
|404|User not found|No Content
|
||||
|===
|
||||
|
||||
==== Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
==== Tags
|
||||
|
||||
* user
|
||||
|
||||
== Definitions
|
||||
=== User
|
||||
[options="header"]
|
||||
|===
|
||||
|Name|Description|Schema|Required
|
||||
|id||integer (int64)|false
|
||||
|username||string|false
|
||||
|firstName||string|false
|
||||
|lastName||string|false
|
||||
|email||string|false
|
||||
|password||string|false
|
||||
|phone||string|false
|
||||
|userStatus|User Status|integer (int32)|false
|
||||
|===
|
||||
|
||||
=== Category
|
||||
[options="header"]
|
||||
|===
|
||||
|Name|Description|Schema|Required
|
||||
|id||integer (int64)|false
|
||||
|name||string|false
|
||||
|===
|
||||
|
||||
=== Pet
|
||||
[options="header"]
|
||||
|===
|
||||
|Name|Description|Schema|Required
|
||||
|id||integer (int64)|false
|
||||
|category||<<Category>>|false
|
||||
|name||string|true
|
||||
|photoUrls||string array|true
|
||||
|tags||<<Tag>> array|false
|
||||
|status|pet status in the store|string|false
|
||||
|===
|
||||
|
||||
=== Tag
|
||||
[options="header"]
|
||||
|===
|
||||
|Name|Description|Schema|Required
|
||||
|id||integer (int64)|false
|
||||
|name||string|false
|
||||
|===
|
||||
|
||||
=== Order
|
||||
[options="header"]
|
||||
|===
|
||||
|Name|Description|Schema|Required
|
||||
|id||integer (int64)|false
|
||||
|petId||integer (int64)|false
|
||||
|quantity||integer (int32)|false
|
||||
|shipDate||string (date-time)|false
|
||||
|status|Order Status|string|false
|
||||
|complete||boolean|false
|
||||
|===
|
||||
|
||||
@@ -1,50 +0,0 @@
|
||||
## Definitions
|
||||
### User
|
||||
|Name|Description|Schema|Required|
|
||||
|----|----|----|----|
|
||||
|id||integer (int64)|false|
|
||||
|username||string|false|
|
||||
|firstName||string|false|
|
||||
|lastName||string|false|
|
||||
|email||string|false|
|
||||
|password||string|false|
|
||||
|phone||string|false|
|
||||
|userStatus|User Status|integer (int32)|false|
|
||||
|
||||
|
||||
### Category
|
||||
|Name|Description|Schema|Required|
|
||||
|----|----|----|----|
|
||||
|id||integer (int64)|false|
|
||||
|name||string|false|
|
||||
|
||||
|
||||
### Pet
|
||||
|Name|Description|Schema|Required|
|
||||
|----|----|----|----|
|
||||
|id||integer (int64)|false|
|
||||
|category||Category|false|
|
||||
|name||string|true|
|
||||
|photoUrls||string array|true|
|
||||
|tags||Tag array|false|
|
||||
|status|pet status in the store|string|false|
|
||||
|
||||
|
||||
### Tag
|
||||
|Name|Description|Schema|Required|
|
||||
|----|----|----|----|
|
||||
|id||integer (int64)|false|
|
||||
|name||string|false|
|
||||
|
||||
|
||||
### Order
|
||||
|Name|Description|Schema|Required|
|
||||
|----|----|----|----|
|
||||
|id||integer (int64)|false|
|
||||
|petId||integer (int64)|false|
|
||||
|quantity||integer (int32)|false|
|
||||
|shipDate||string (date-time)|false|
|
||||
|status|Order Status|string|false|
|
||||
|complete||boolean|false|
|
||||
|
||||
|
||||
@@ -1,547 +0,0 @@
|
||||
# Swagger Petstore
|
||||
|
||||
This is a sample server Petstore server.
|
||||
|
||||
[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.
|
||||
|
||||
For this sample, you can use the api key `special-key` to test the authorization filters
|
||||
|
||||
Version: 1.0.0
|
||||
Contact: apiteam@wordnik.com
|
||||
License: Apache 2.0
|
||||
License URL: http://www.apache.org/licenses/LICENSE-2.0.html
|
||||
Terms of service: http://helloreverb.com/terms/
|
||||
|
||||
Host: petstore.swagger.wordnik.com
|
||||
BasePath: /v2
|
||||
Schemes: HTTP
|
||||
|
||||
## Paths
|
||||
### Update an existing pet
|
||||
```
|
||||
PUT /pets
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|BodyParameter|body|Pet object that needs to be added to the store|false|Pet|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|400|Invalid ID supplied|No Content|
|
||||
|404|Pet not found|No Content|
|
||||
|405|Validation exception|No Content|
|
||||
|
||||
|
||||
### Consumes
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* pet
|
||||
|
||||
### Add a new pet to the store
|
||||
```
|
||||
POST /pets
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|BodyParameter|body|Pet object that needs to be added to the store|false|Pet|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|405|Invalid input|No Content|
|
||||
|
||||
|
||||
### Consumes
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* pet
|
||||
|
||||
### Finds Pets by status
|
||||
```
|
||||
GET /pets/findByStatus
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Multiple status values can be provided with comma seperated strings
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|QueryParameter|status|Status values that need to be considered for filter|false|multi string array|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|200|successful operation|Pet array|
|
||||
|400|Invalid status value|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* pet
|
||||
|
||||
### Finds Pets by tags
|
||||
```
|
||||
GET /pets/findByTags
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|QueryParameter|tags|Tags to filter by|false|multi string array|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|200|successful operation|Pet array|
|
||||
|400|Invalid tag value|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* pet
|
||||
|
||||
### Find pet by ID
|
||||
```
|
||||
GET /pets/{petId}
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|PathParameter|petId|ID of pet that needs to be fetched|true|integer (int64)|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|200|successful operation|Pet|
|
||||
|400|Invalid ID supplied|No Content|
|
||||
|404|Pet not found|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* pet
|
||||
|
||||
### Deletes a pet
|
||||
```
|
||||
DELETE /pets/{petId}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|HeaderParameter|api_key||true|string|
|
||||
|PathParameter|petId|Pet id to delete|true|integer (int64)|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|400|Invalid pet value|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* pet
|
||||
|
||||
### Updates a pet in the store with form data
|
||||
```
|
||||
POST /pets/{petId}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|PathParameter|petId|ID of pet that needs to be updated|true|string|
|
||||
|FormDataParameter|name|Updated name of the pet|true|string|
|
||||
|FormDataParameter|status|Updated status of the pet|true|string|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|405|Invalid input|No Content|
|
||||
|
||||
|
||||
### Consumes
|
||||
|
||||
* application/x-www-form-urlencoded
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* pet
|
||||
|
||||
### Place an order for a pet
|
||||
```
|
||||
POST /stores/order
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|BodyParameter|body|order placed for purchasing the pet|false|Order|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|200|successful operation|Order|
|
||||
|400|Invalid Order|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* store
|
||||
|
||||
### Find purchase order by ID
|
||||
```
|
||||
GET /stores/order/{orderId}
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|PathParameter|orderId|ID of pet that needs to be fetched|true|string|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|200|successful operation|Order|
|
||||
|400|Invalid ID supplied|No Content|
|
||||
|404|Order not found|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* store
|
||||
|
||||
### Delete purchase order by ID
|
||||
```
|
||||
DELETE /stores/order/{orderId}
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|PathParameter|orderId|ID of the order that needs to be deleted|true|string|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|400|Invalid ID supplied|No Content|
|
||||
|404|Order not found|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* store
|
||||
|
||||
### Create user
|
||||
```
|
||||
POST /users
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This can only be done by the logged in user.
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|BodyParameter|body|Created user object|false|User|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|default|successful operation|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* user
|
||||
|
||||
### Creates list of users with given input array
|
||||
```
|
||||
POST /users/createWithArray
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|BodyParameter|body|List of user object|false|User array|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|default|successful operation|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* user
|
||||
|
||||
### Creates list of users with given input array
|
||||
```
|
||||
POST /users/createWithList
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|BodyParameter|body|List of user object|false|User array|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|default|successful operation|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* user
|
||||
|
||||
### Logs user into the system
|
||||
```
|
||||
GET /users/login
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|QueryParameter|username|The user name for login|false|string|
|
||||
|QueryParameter|password|The password for login in clear text|false|string|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|200|successful operation|string|
|
||||
|400|Invalid username/password supplied|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* user
|
||||
|
||||
### Logs out current logged in user session
|
||||
```
|
||||
GET /users/logout
|
||||
```
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|default|successful operation|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* user
|
||||
|
||||
### Get user by user name
|
||||
```
|
||||
GET /users/{username}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|PathParameter|username|The name that needs to be fetched. Use user1 for testing.|true|string|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|200|successful operation|User|
|
||||
|400|Invalid username supplied|No Content|
|
||||
|404|User not found|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* user
|
||||
|
||||
### Updated user
|
||||
```
|
||||
PUT /users/{username}
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This can only be done by the logged in user.
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|PathParameter|username|name that need to be deleted|true|string|
|
||||
|BodyParameter|body|Updated user object|false|User|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|400|Invalid user supplied|No Content|
|
||||
|404|User not found|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* user
|
||||
|
||||
### Delete user
|
||||
```
|
||||
DELETE /users/{username}
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This can only be done by the logged in user.
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|PathParameter|username|The name that needs to be deleted|true|string|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|400|Invalid username supplied|No Content|
|
||||
|404|User not found|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* user
|
||||
|
||||
@@ -1,171 +0,0 @@
|
||||
package io.github.robwin.swagger2markup;
|
||||
|
||||
import com.wordnik.swagger.models.Swagger;
|
||||
import io.github.robwin.markup.builder.MarkupLanguage;
|
||||
import io.github.robwin.swagger2markup.builder.document.DefinitionsDocument;
|
||||
import io.github.robwin.swagger2markup.builder.document.PathsDocument;
|
||||
import io.swagger.parser.SwaggerParser;
|
||||
import org.apache.commons.lang.Validate;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
|
||||
/**
|
||||
* @author Robert Winkler
|
||||
*/
|
||||
public class Swagger2MarkupConverter {
|
||||
private static final Logger LOG = LoggerFactory.getLogger(Swagger2MarkupConverter.class);
|
||||
|
||||
private final Swagger swagger;
|
||||
private final MarkupLanguage markupLanguage;
|
||||
private final String examplesFolderPath;
|
||||
private final String schemasFolderPath;
|
||||
private static final String PATHS_DOCUMENT = "paths";
|
||||
private static final String DEFINITIONS_DOCUMENT = "definitions";
|
||||
|
||||
/**
|
||||
* @param markupLanguage the markup language which is used to generate the files
|
||||
* @param swagger the Swagger object
|
||||
* @param examplesFolderPath the folderPath where examples are stored
|
||||
* @param schemasFolderPath the folderPath where (XML, JSON)-Schema files are stored
|
||||
*/
|
||||
Swagger2MarkupConverter(MarkupLanguage markupLanguage, Swagger swagger, String examplesFolderPath, String schemasFolderPath){
|
||||
this.markupLanguage = markupLanguage;
|
||||
this.swagger = swagger;
|
||||
this.examplesFolderPath = examplesFolderPath;
|
||||
this.schemasFolderPath = schemasFolderPath;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a Swagger2MarkupConverter.Builder using a given Swagger source.
|
||||
*
|
||||
* @param swaggerSource the Swagger source. Can be a HTTP url or a path to a local file.
|
||||
* @return a Swagger2MarkupConverter
|
||||
*/
|
||||
public static Builder from(String swaggerSource){
|
||||
Validate.notEmpty(swaggerSource, "swaggerSource must not be empty!");
|
||||
return new Builder(swaggerSource);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a Swagger2MarkupConverter.Builder from a given Swagger model.
|
||||
*
|
||||
* @param swagger the Swagger source.
|
||||
* @return a Swagger2MarkupConverter
|
||||
*/
|
||||
public static Builder from(Swagger swagger){
|
||||
Validate.notNull(swagger, "swagger must not be null!");
|
||||
return new Builder(swagger);
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the document with the given markup language and stores
|
||||
* the files in the given folder.
|
||||
*
|
||||
* @param targetFolderPath the target folder
|
||||
* @throws IOException if the files cannot be written
|
||||
*/
|
||||
public void intoFolder(String targetFolderPath) throws IOException {
|
||||
Validate.notEmpty(targetFolderPath, "folderPath must not be null!");
|
||||
buildDocuments(targetFolderPath);
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the document with the given markup language and returns it as a String
|
||||
*
|
||||
* @return a the document as a String
|
||||
*/
|
||||
public String asString() throws IOException{
|
||||
return buildDocuments();
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes a file for the Paths (API) and a file for the Definitions (Model)
|
||||
|
||||
* @param directory the directory where the generated file should be stored
|
||||
* @throws IOException if a file cannot be written
|
||||
*/
|
||||
private void buildDocuments(String directory) throws IOException {
|
||||
new PathsDocument(swagger, markupLanguage, examplesFolderPath).build().writeToFile(directory, PATHS_DOCUMENT, StandardCharsets.UTF_8);
|
||||
new DefinitionsDocument(swagger, markupLanguage, schemasFolderPath).build().writeToFile(directory, DEFINITIONS_DOCUMENT, StandardCharsets.UTF_8);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a file for the Paths (API) and a file for the Definitions (Model)
|
||||
|
||||
* @return a the document as a String
|
||||
*/
|
||||
private String buildDocuments() throws IOException {
|
||||
return new PathsDocument(swagger, markupLanguage, examplesFolderPath).build().toString()
|
||||
.concat(new DefinitionsDocument(swagger, markupLanguage, schemasFolderPath).build().toString());
|
||||
}
|
||||
|
||||
|
||||
public static class Builder{
|
||||
private final Swagger swagger;
|
||||
private String examplesFolderPath;
|
||||
private String schemasFolderPath;
|
||||
private MarkupLanguage markupLanguage = MarkupLanguage.ASCIIDOC;
|
||||
|
||||
/**
|
||||
* Creates a Builder using a given Swagger source.
|
||||
*
|
||||
* @param swaggerSource the Swagger source. Can be a HTTP url or a path to a local file.
|
||||
*/
|
||||
Builder(String swaggerSource){
|
||||
swagger = new SwaggerParser().read(swaggerSource);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a Builder using a given Swagger model.
|
||||
*
|
||||
* @param swagger the Swagger source.
|
||||
*/
|
||||
Builder(Swagger swagger){
|
||||
this.swagger = swagger;
|
||||
}
|
||||
|
||||
|
||||
|
||||
public Swagger2MarkupConverter build(){
|
||||
return new Swagger2MarkupConverter(markupLanguage, swagger, examplesFolderPath, schemasFolderPath);
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies the markup language which should be used to generate the files
|
||||
*
|
||||
* @param markupLanguage the markup language which is used to generate the files
|
||||
* @return the Swagger2MarkupConverter.Builder
|
||||
*/
|
||||
public Builder withMarkupLanguage(MarkupLanguage markupLanguage){
|
||||
this.markupLanguage = markupLanguage;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Include examples into the Paths document
|
||||
*
|
||||
* @param examplesFolderPath the path to the folder where the example documents reside
|
||||
* @return the Swagger2MarkupConverter.Builder
|
||||
*/
|
||||
public Builder withExamples(String examplesFolderPath){
|
||||
this.examplesFolderPath = examplesFolderPath;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Include (JSON, XML) schemas into the Definitions document
|
||||
*
|
||||
* @param schemasFolderPath the path to the folder where the schema documents reside
|
||||
* @return the Swagger2MarkupConverter.Builder
|
||||
*/
|
||||
public Builder withSchemas(String schemasFolderPath){
|
||||
this.schemasFolderPath = schemasFolderPath;
|
||||
return this;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,149 +0,0 @@
|
||||
package io.github.robwin.swagger2markup.builder.document;
|
||||
|
||||
import com.wordnik.swagger.models.Model;
|
||||
import com.wordnik.swagger.models.Swagger;
|
||||
import com.wordnik.swagger.models.properties.AbstractProperty;
|
||||
import com.wordnik.swagger.models.properties.Property;
|
||||
import io.github.robwin.markup.builder.MarkupLanguage;
|
||||
import io.github.robwin.swagger2markup.utils.PropertyUtils;
|
||||
import org.apache.commons.collections.MapUtils;
|
||||
import org.apache.commons.io.FileUtils;
|
||||
import org.apache.commons.lang.StringUtils;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Paths;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* @author Robert Winkler
|
||||
*/
|
||||
public class DefinitionsDocument extends MarkupDocument {
|
||||
|
||||
private static final String DEFINITIONS = "Definitions";
|
||||
private static final List<String> IGNORED_DEFINITIONS = Arrays.asList("Void");
|
||||
private static final String JSON_SCHEMA = "JSON Schema";
|
||||
private static final String XML_SCHEMA = "XML Schema";
|
||||
public static final String JSON_SCHEMA_EXTENSION = ".json";
|
||||
public static final String XML_SCHEMA_EXTENSION = ".xsd";
|
||||
public static final String JSON = "json";
|
||||
public static final String XML = "xml";
|
||||
private boolean schemasEnabled;
|
||||
private String schemasFolderPath;
|
||||
|
||||
public DefinitionsDocument(Swagger swagger, MarkupLanguage markupLanguage, String schemasFolderPath){
|
||||
super(swagger, markupLanguage);
|
||||
if(StringUtils.isNotBlank(schemasFolderPath)){
|
||||
this.schemasEnabled = true;
|
||||
this.schemasFolderPath = schemasFolderPath;
|
||||
}
|
||||
if(schemasEnabled){
|
||||
if (logger.isDebugEnabled()) {
|
||||
logger.debug("Include schemas is enabled.");
|
||||
}
|
||||
}else{
|
||||
if (logger.isDebugEnabled()) {
|
||||
logger.debug("Include schemas is disabled.");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public MarkupDocument build() throws IOException {
|
||||
definitions(swagger.getDefinitions());
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the Swagger definitions.
|
||||
*
|
||||
* @param definitions the Swagger definitions
|
||||
*/
|
||||
private void definitions(Map<String, Model> definitions) throws IOException {
|
||||
if(MapUtils.isNotEmpty(definitions)){
|
||||
this.markupDocBuilder.sectionTitleLevel1(DEFINITIONS);
|
||||
for(Map.Entry<String, Model> definitionsEntry : definitions.entrySet()){
|
||||
String definitionName = definitionsEntry.getKey();
|
||||
if(StringUtils.isNotBlank(definitionName)) {
|
||||
if (checkThatDefinitionIsNotInIgnoreList(definitionName)) {
|
||||
definition(definitionName, definitionsEntry.getValue());
|
||||
definitionSchema(definitionName);
|
||||
if (logger.isInfoEnabled()) {
|
||||
logger.info("Definition processed: {}", definitionName);
|
||||
}
|
||||
}else{
|
||||
if (logger.isDebugEnabled()) {
|
||||
logger.debug("Definition was ignored: {}", definitionName);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks that the definition is not in the list of ignored definitions.
|
||||
*
|
||||
* @param definitionName the name of the definition
|
||||
* @return true if the definition can be processed
|
||||
*/
|
||||
private boolean checkThatDefinitionIsNotInIgnoreList(String definitionName) {
|
||||
return !IGNORED_DEFINITIONS.contains(definitionName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds a concrete definition
|
||||
*
|
||||
* @param definitionName the name of the definition
|
||||
* @param model the Swagger Model of the definition
|
||||
*/
|
||||
private void definition(String definitionName, Model model) {
|
||||
this.markupDocBuilder.sectionTitleLevel2(definitionName);
|
||||
Map<String, Property> properties = model.getProperties();
|
||||
List<String> headerAndContent = new ArrayList<>();
|
||||
List<String> header = Arrays.asList(NAME_COLUMN, DESCRIPTION_COLUMN, SCHEMA_COLUMN, REQUIRED_COLUMN);
|
||||
headerAndContent.add(StringUtils.join(header, DELIMITER));
|
||||
for (Map.Entry<String, Property> propertyEntry : properties.entrySet()) {
|
||||
Property property = propertyEntry.getValue();
|
||||
String description = "";
|
||||
if(property instanceof AbstractProperty){
|
||||
if(StringUtils.isNotBlank(property.getDescription())){
|
||||
description = property.getDescription();
|
||||
}
|
||||
}
|
||||
String type = PropertyUtils.getType(property, markupLanguage);
|
||||
List<String> content = Arrays.asList(propertyEntry.getKey(), description, type, Boolean.toString(property.getRequired()));
|
||||
headerAndContent.add(StringUtils.join(content, DELIMITER));
|
||||
}
|
||||
this.markupDocBuilder.tableWithHeaderRow(headerAndContent);
|
||||
}
|
||||
|
||||
private void definitionSchema(String definitionName) throws IOException {
|
||||
if(schemasEnabled) {
|
||||
if (StringUtils.isNotBlank(definitionName)) {
|
||||
schema(JSON_SCHEMA, schemasFolderPath, definitionName + JSON_SCHEMA_EXTENSION, JSON);
|
||||
schema(XML_SCHEMA, schemasFolderPath, definitionName + XML_SCHEMA_EXTENSION, XML);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void schema(String title, String schemasFolderPath, String schemaName, String language) throws IOException {
|
||||
java.nio.file.Path path = Paths.get(schemasFolderPath, schemaName);
|
||||
if (Files.isReadable(path)) {
|
||||
this.markupDocBuilder.sectionTitleLevel3(title);
|
||||
this.markupDocBuilder.source(FileUtils.readFileToString(path.toFile(), StandardCharsets.UTF_8).trim(), language);
|
||||
if (logger.isInfoEnabled()) {
|
||||
logger.info("Schema file processed: {}", path);
|
||||
}
|
||||
} else {
|
||||
if (logger.isDebugEnabled()) {
|
||||
logger.debug("Schema file is not readable: {}", path);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
@@ -1,61 +0,0 @@
|
||||
package io.github.robwin.swagger2markup.builder.document;
|
||||
|
||||
import com.wordnik.swagger.models.Swagger;
|
||||
import io.github.robwin.markup.builder.MarkupDocBuilder;
|
||||
import io.github.robwin.markup.builder.MarkupDocBuilders;
|
||||
import io.github.robwin.markup.builder.MarkupLanguage;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.nio.charset.Charset;
|
||||
|
||||
/**
|
||||
* @author Robert Winkler
|
||||
*/
|
||||
public abstract class MarkupDocument {
|
||||
|
||||
protected static final String DELIMITER = "|";
|
||||
protected static final String REQUIRED_COLUMN = "Required";
|
||||
protected static final String SCHEMA_COLUMN = "Schema";
|
||||
protected static final String NAME_COLUMN = "Name";
|
||||
protected static final String DESCRIPTION_COLUMN = "Description";
|
||||
protected static final String DESCRIPTION = DESCRIPTION_COLUMN;
|
||||
protected Logger logger = LoggerFactory.getLogger(getClass());
|
||||
protected Swagger swagger;
|
||||
protected MarkupLanguage markupLanguage;
|
||||
protected MarkupDocBuilder markupDocBuilder;
|
||||
|
||||
MarkupDocument(Swagger swagger, MarkupLanguage markupLanguage){
|
||||
this.swagger = swagger;
|
||||
this.markupLanguage = markupLanguage;
|
||||
this.markupDocBuilder = MarkupDocBuilders.documentBuilder(markupLanguage);
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the MarkupDocument.
|
||||
*
|
||||
* @return the built MarkupDocument
|
||||
* @throws IOException if the files to include are not readable
|
||||
*/
|
||||
public abstract MarkupDocument build() throws IOException ;
|
||||
|
||||
/**
|
||||
* Returns a string representation of the document.
|
||||
*/
|
||||
public String toString(){
|
||||
return markupDocBuilder.toString();
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes the content of the builder to a file and clears the builder.
|
||||
*
|
||||
* @param directory the directory where the generated file should be stored
|
||||
* @param fileName the name of the file
|
||||
* @param charset the the charset to use for encoding
|
||||
* @throws IOException if the file cannot be written
|
||||
*/
|
||||
public void writeToFile(String directory, String fileName, Charset charset) throws IOException{
|
||||
markupDocBuilder.writeToFile(directory, fileName, charset);
|
||||
}
|
||||
}
|
||||
@@ -1,298 +0,0 @@
|
||||
package io.github.robwin.swagger2markup.builder.document;
|
||||
|
||||
import com.wordnik.swagger.models.*;
|
||||
import com.wordnik.swagger.models.parameters.Parameter;
|
||||
import com.wordnik.swagger.models.properties.Property;
|
||||
import io.github.robwin.markup.builder.MarkupLanguage;
|
||||
import io.github.robwin.swagger2markup.utils.ParameterUtils;
|
||||
import io.github.robwin.swagger2markup.utils.PropertyUtils;
|
||||
import org.apache.commons.collections.CollectionUtils;
|
||||
import org.apache.commons.collections.MapUtils;
|
||||
import org.apache.commons.io.FileUtils;
|
||||
import org.apache.commons.lang.StringUtils;
|
||||
import org.apache.commons.lang.WordUtils;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Paths;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* @author Robert Winkler
|
||||
*/
|
||||
public class PathsDocument extends MarkupDocument {
|
||||
|
||||
private static final String PATHS = "Paths";
|
||||
private static final String VERSION = "Version: ";
|
||||
private static final String CONTACT_NAME = "Contact: ";
|
||||
private static final String CONTACT_EMAIL = "Contact Email: ";
|
||||
private static final String LICENSE = "License: ";
|
||||
private static final String LICENSE_URL = "License URL: ";
|
||||
private static final String TERMS_OF_SERVICE = "Terms of service: ";
|
||||
private static final String HOST = "Host: ";
|
||||
private static final String BASE_PATH = "BasePath: ";
|
||||
private static final String SCHEMES = "Schemes: ";
|
||||
private static final String PARAMETERS = "Parameters";
|
||||
private static final String PRODUCES = "Produces";
|
||||
private static final String CONSUMES = "Consumes";
|
||||
private static final String TAGS = "Tags";
|
||||
private static final String RESPONSES = "Responses";
|
||||
private static final String EXAMPLE_REQUEST = "Example request";
|
||||
private static final String EXAMPLE_RESPONSE = "Example response";
|
||||
private static final String TYPE_COLUMN = "Type";
|
||||
private static final String HTTP_CODE_COLUMN = "HTTP Code";
|
||||
private static final String REQUEST_EXAMPLE_FILE_NAME = "request";
|
||||
private static final String RESPONSE_EXAMPLE_FILE_NAME = "response";
|
||||
|
||||
private boolean examplesEnabled;
|
||||
private String examplesFolderPath;
|
||||
|
||||
public PathsDocument(Swagger swagger, MarkupLanguage markupLanguage, String examplesFolderPath){
|
||||
super(swagger, markupLanguage);
|
||||
if(StringUtils.isNotBlank(examplesFolderPath)){
|
||||
this.examplesEnabled = true;
|
||||
this.examplesFolderPath = examplesFolderPath;
|
||||
}
|
||||
if(examplesEnabled){
|
||||
if (logger.isDebugEnabled()) {
|
||||
logger.debug("Include examples is enabled.");
|
||||
}
|
||||
}else{
|
||||
if (logger.isDebugEnabled()) {
|
||||
logger.debug("Include examples is disabled.");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public MarkupDocument build() throws IOException {
|
||||
documentHeader();
|
||||
paths();
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the document header of the swagger model
|
||||
*/
|
||||
private void documentHeader() {
|
||||
Info info = swagger.getInfo();
|
||||
this.markupDocBuilder.documentTitle(info.getTitle());
|
||||
if(StringUtils.isNotBlank(info.getDescription())){
|
||||
this.markupDocBuilder.textLine(info.getDescription());
|
||||
}
|
||||
if(StringUtils.isNotBlank(info.getVersion())){
|
||||
this.markupDocBuilder.textLine(VERSION + info.getVersion());
|
||||
}
|
||||
Contact contact = info.getContact();
|
||||
if(contact != null){
|
||||
if(StringUtils.isNotBlank(contact.getName())){
|
||||
this.markupDocBuilder.textLine(CONTACT_NAME + contact.getName());
|
||||
}
|
||||
if(StringUtils.isNotBlank(contact.getEmail())){
|
||||
this.markupDocBuilder.textLine(CONTACT_EMAIL + contact.getEmail());
|
||||
}
|
||||
}
|
||||
License license = info.getLicense();
|
||||
if(license != null) {
|
||||
if (StringUtils.isNotBlank(license.getName())) {
|
||||
this.markupDocBuilder.textLine(LICENSE + license.getName());
|
||||
}
|
||||
if (StringUtils.isNotBlank(license.getUrl())) {
|
||||
this.markupDocBuilder.textLine(LICENSE_URL + license.getUrl());
|
||||
}
|
||||
}
|
||||
if(StringUtils.isNotBlank(info.getTermsOfService())){
|
||||
this.markupDocBuilder.textLine(TERMS_OF_SERVICE + info.getTermsOfService());
|
||||
}
|
||||
this.markupDocBuilder.newLine();
|
||||
|
||||
if(StringUtils.isNotBlank(swagger.getHost())){
|
||||
this.markupDocBuilder.textLine(HOST + swagger.getHost());
|
||||
}
|
||||
if(StringUtils.isNotBlank(swagger.getBasePath())){
|
||||
this.markupDocBuilder.textLine(BASE_PATH + swagger.getBasePath());
|
||||
}
|
||||
if(CollectionUtils.isNotEmpty(swagger.getSchemes())){
|
||||
List<String> schemes = new ArrayList<>();
|
||||
for(Scheme scheme : swagger.getSchemes()){
|
||||
schemes.add(scheme.toString());
|
||||
}
|
||||
this.markupDocBuilder.textLine(SCHEMES + StringUtils.join(schemes, ", "));
|
||||
}
|
||||
this.markupDocBuilder.newLine();
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds all paths of the Swagger model
|
||||
*/
|
||||
private void paths() throws IOException {
|
||||
Map<String, Path> paths = swagger.getPaths();
|
||||
if(MapUtils.isNotEmpty(paths)) {
|
||||
this.markupDocBuilder.sectionTitleLevel1(PATHS);
|
||||
for (Map.Entry<String, Path> entry : paths.entrySet()) {
|
||||
Path path = entry.getValue();
|
||||
path("GET", entry.getKey(), path.getGet());
|
||||
path("PUT", entry.getKey(), path.getPut());
|
||||
path("DELETE", entry.getKey(), path.getDelete());
|
||||
path("POST", entry.getKey(), path.getPost());
|
||||
path("PATCH", entry.getKey(), path.getPatch());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds a path
|
||||
*
|
||||
* @param httpMethod the HTTP method of the path
|
||||
* @param resourcePath the URL of the path
|
||||
* @param operation the Swagger Operation
|
||||
*/
|
||||
private void path(String httpMethod, String resourcePath, Operation operation) throws IOException {
|
||||
if(operation != null){
|
||||
pathTitle(httpMethod, resourcePath, operation);
|
||||
descriptionSection(operation);
|
||||
parametersSection(operation);
|
||||
responsesSection(operation);
|
||||
consumesSection(operation);
|
||||
producesSection(operation);
|
||||
tagsSection(operation);
|
||||
examplesSection(operation);
|
||||
}
|
||||
}
|
||||
|
||||
private void pathTitle(String httpMethod, String resourcePath, Operation operation) {
|
||||
String summary = operation.getSummary();
|
||||
String title;
|
||||
if(StringUtils.isNotBlank(summary)) {
|
||||
title = summary;
|
||||
this.markupDocBuilder.sectionTitleLevel2(title);
|
||||
this.markupDocBuilder.listing(httpMethod + " " + resourcePath);
|
||||
}else{
|
||||
title = httpMethod + " " + resourcePath;
|
||||
this.markupDocBuilder.sectionTitleLevel2(title);
|
||||
}
|
||||
if (logger.isInfoEnabled()) {
|
||||
logger.info("Path processed: {}", title);
|
||||
}
|
||||
}
|
||||
|
||||
private void descriptionSection(Operation operation) {
|
||||
String description = operation.getDescription();
|
||||
if(StringUtils.isNotBlank(description)){
|
||||
this.markupDocBuilder.sectionTitleLevel3(DESCRIPTION);
|
||||
this.markupDocBuilder.paragraph(description);
|
||||
}
|
||||
}
|
||||
|
||||
private void parametersSection(Operation operation) {
|
||||
List<Parameter> parameters = operation.getParameters();
|
||||
if(CollectionUtils.isNotEmpty(parameters)){
|
||||
List<String> headerAndContent = new ArrayList<>();
|
||||
// Table header row
|
||||
List<String> header = Arrays.asList(TYPE_COLUMN, NAME_COLUMN, DESCRIPTION_COLUMN, REQUIRED_COLUMN, SCHEMA_COLUMN);
|
||||
headerAndContent.add(StringUtils.join(header, DELIMITER));
|
||||
for(Parameter parameter : parameters){
|
||||
String type = ParameterUtils.getType(parameter, markupLanguage);
|
||||
String parameterType = WordUtils.capitalize(parameter.getIn() + "Parameter");
|
||||
// Table content row
|
||||
List<String> content = Arrays.asList(parameterType, parameter.getName(), parameter.getDescription(), Boolean.toString(parameter.getRequired()), type);
|
||||
headerAndContent.add(StringUtils.join(content, DELIMITER));
|
||||
}
|
||||
this.markupDocBuilder.sectionTitleLevel3(PARAMETERS);
|
||||
this.markupDocBuilder.tableWithHeaderRow(headerAndContent);
|
||||
}
|
||||
}
|
||||
|
||||
private void consumesSection(Operation operation) {
|
||||
List<String> consumes = operation.getConsumes();
|
||||
if(CollectionUtils.isNotEmpty(consumes)){
|
||||
this.markupDocBuilder.sectionTitleLevel3(CONSUMES);
|
||||
this.markupDocBuilder.unorderedList(consumes);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
private void producesSection(Operation operation) {
|
||||
List<String> produces = operation.getProduces();
|
||||
if(CollectionUtils.isNotEmpty(produces)){
|
||||
this.markupDocBuilder.sectionTitleLevel3(PRODUCES);
|
||||
this.markupDocBuilder.unorderedList(produces);
|
||||
}
|
||||
}
|
||||
|
||||
private void tagsSection(Operation operation) {
|
||||
List<String> tags = operation.getTags();
|
||||
if(CollectionUtils.isNotEmpty(tags)){
|
||||
this.markupDocBuilder.sectionTitleLevel3(TAGS);
|
||||
this.markupDocBuilder.unorderedList(tags);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the example section of a Swagger Operation
|
||||
*
|
||||
* @param operation the Swagger Operation
|
||||
* @throws IOException if the example file is not readable
|
||||
*/
|
||||
private void examplesSection(Operation operation) throws IOException {
|
||||
if(examplesEnabled){
|
||||
String summary = operation.getSummary();
|
||||
if(StringUtils.isNotBlank(summary)) {
|
||||
String exampleFolder = summary.replace(".", "").replace(" ", "_").toLowerCase();
|
||||
example(EXAMPLE_REQUEST, exampleFolder, REQUEST_EXAMPLE_FILE_NAME);
|
||||
example(EXAMPLE_RESPONSE, exampleFolder, RESPONSE_EXAMPLE_FILE_NAME);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds a concrete example
|
||||
*
|
||||
* @param title the title of the example
|
||||
* @param exampleFolder the name of the folder where the example file resides
|
||||
* @param exampleFileName the name of the example file
|
||||
* @throws IOException
|
||||
*/
|
||||
private void example(String title, String exampleFolder, String exampleFileName) throws IOException {
|
||||
for (String fileNameExtension : markupLanguage.getFileNameExtensions()) {
|
||||
java.nio.file.Path path = Paths.get(examplesFolderPath, exampleFolder, exampleFileName + fileNameExtension);
|
||||
if (Files.isReadable(path)) {
|
||||
this.markupDocBuilder.sectionTitleLevel3(title);
|
||||
this.markupDocBuilder.paragraph(FileUtils.readFileToString(path.toFile(), StandardCharsets.UTF_8).trim());
|
||||
if (logger.isInfoEnabled()) {
|
||||
logger.info("Example file processed: {}", path);
|
||||
}
|
||||
break;
|
||||
} else {
|
||||
if (logger.isDebugEnabled()) {
|
||||
logger.debug("Example file is not readable: {}", path);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void responsesSection(Operation operation) {
|
||||
Map<String, Response> responses = operation.getResponses();
|
||||
if(MapUtils.isNotEmpty(responses)){
|
||||
List<String> csvContent = new ArrayList<>();
|
||||
csvContent.add(HTTP_CODE_COLUMN + DELIMITER + DESCRIPTION_COLUMN + DELIMITER + SCHEMA_COLUMN);
|
||||
for(Map.Entry<String, Response> entry : responses.entrySet()){
|
||||
Response response = entry.getValue();
|
||||
if(response.getSchema() != null){
|
||||
Property property = response.getSchema();
|
||||
String type = PropertyUtils.getType(property, markupLanguage);
|
||||
csvContent.add(entry.getKey() + DELIMITER + response.getDescription() + DELIMITER + type);
|
||||
}else{
|
||||
csvContent.add(entry.getKey() + DELIMITER + response.getDescription() + DELIMITER + "No Content");
|
||||
}
|
||||
}
|
||||
this.markupDocBuilder.sectionTitleLevel3(RESPONSES);
|
||||
this.markupDocBuilder.tableWithHeaderRow(csvContent);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,27 +0,0 @@
|
||||
package io.github.robwin.swagger2markup.utils;
|
||||
|
||||
import com.wordnik.swagger.models.ArrayModel;
|
||||
import com.wordnik.swagger.models.Model;
|
||||
import com.wordnik.swagger.models.ModelImpl;
|
||||
import com.wordnik.swagger.models.RefModel;
|
||||
import io.github.robwin.markup.builder.MarkupLanguage;
|
||||
import org.apache.commons.lang.Validate;
|
||||
|
||||
public final class ModelUtils {
|
||||
|
||||
public static String getType(Model model, MarkupLanguage markupLanguage) {
|
||||
Validate.notNull(model, "model must not be null!");
|
||||
if (model instanceof ModelImpl) {
|
||||
return ((ModelImpl) model).getType();
|
||||
} else if (model instanceof RefModel) {
|
||||
switch (markupLanguage){
|
||||
case ASCIIDOC: return "<<" + ((RefModel) model).getSimpleRef() + ">>";
|
||||
default: return ((RefModel) model).getSimpleRef();
|
||||
}
|
||||
} else if (model instanceof ArrayModel) {
|
||||
ArrayModel arrayModel = ((ArrayModel) model);
|
||||
return PropertyUtils.getType(arrayModel.getItems(), markupLanguage) + " " + arrayModel.getType();
|
||||
}
|
||||
return "NOT FOUND";
|
||||
}
|
||||
}
|
||||
@@ -1,62 +0,0 @@
|
||||
package io.github.robwin.swagger2markup.utils;
|
||||
|
||||
import com.wordnik.swagger.models.Model;
|
||||
import com.wordnik.swagger.models.parameters.*;
|
||||
import io.github.robwin.markup.builder.MarkupLanguage;
|
||||
import org.apache.commons.lang.StringUtils;
|
||||
import org.apache.commons.lang.Validate;
|
||||
|
||||
public final class ParameterUtils {
|
||||
|
||||
public static String getType(Parameter parameter, MarkupLanguage markupLanguage){
|
||||
Validate.notNull(parameter, "property must not be null!");
|
||||
String type = "NOT FOUND";
|
||||
if(parameter instanceof BodyParameter){
|
||||
BodyParameter bodyParameter = (BodyParameter)parameter;
|
||||
Model model = bodyParameter.getSchema();
|
||||
type = ModelUtils.getType(model, markupLanguage);
|
||||
}
|
||||
else if(parameter instanceof PathParameter){
|
||||
PathParameter pathParameter = (PathParameter)parameter;
|
||||
type = getTypeWithFormat(pathParameter.getType(), pathParameter.getFormat());
|
||||
}
|
||||
else if(parameter instanceof QueryParameter){
|
||||
QueryParameter queryParameter = (QueryParameter)parameter;
|
||||
type = getTypeWithFormat(queryParameter.getType(), queryParameter.getFormat());
|
||||
if(type.equals("array")){
|
||||
String collectionFormat = queryParameter.getCollectionFormat();
|
||||
type = collectionFormat + " " + PropertyUtils.getType(queryParameter.getItems(), markupLanguage) + " " + type;
|
||||
}
|
||||
}
|
||||
else if(parameter instanceof HeaderParameter){
|
||||
HeaderParameter headerParameter = (HeaderParameter)parameter;
|
||||
type = getTypeWithFormat(headerParameter.getType(), headerParameter.getFormat());
|
||||
}
|
||||
else if(parameter instanceof FormParameter){
|
||||
FormParameter formParameter = (FormParameter)parameter;
|
||||
type = formParameter.getType();
|
||||
}
|
||||
else if(parameter instanceof CookieParameter){
|
||||
CookieParameter cookieParameter = (CookieParameter)parameter;
|
||||
type = getTypeWithFormat(cookieParameter.getType(), cookieParameter.getFormat());
|
||||
}
|
||||
else if(parameter instanceof RefParameter){
|
||||
RefParameter refParameter = (RefParameter)parameter;
|
||||
switch (markupLanguage){
|
||||
case ASCIIDOC: return "<<" + refParameter.getSimpleRef() + ">>";
|
||||
default: return refParameter.getSimpleRef();
|
||||
}
|
||||
}
|
||||
return type;
|
||||
}
|
||||
|
||||
private static String getTypeWithFormat(String typeWithoutFormat, String format) {
|
||||
String type;
|
||||
if(StringUtils.isNotBlank(format)){
|
||||
type = typeWithoutFormat + " (" + format + ")";
|
||||
}else{
|
||||
type = typeWithoutFormat;
|
||||
}
|
||||
return type;
|
||||
}
|
||||
}
|
||||
@@ -1,47 +0,0 @@
|
||||
package io.github.robwin.swagger2markup.utils;
|
||||
|
||||
import com.wordnik.swagger.models.properties.ArrayProperty;
|
||||
import com.wordnik.swagger.models.properties.Property;
|
||||
import com.wordnik.swagger.models.properties.RefProperty;
|
||||
import com.wordnik.swagger.models.properties.StringProperty;
|
||||
import io.github.robwin.markup.builder.MarkupLanguage;
|
||||
import org.apache.commons.collections.CollectionUtils;
|
||||
import org.apache.commons.lang.StringUtils;
|
||||
import org.apache.commons.lang.Validate;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
public final class PropertyUtils {
|
||||
|
||||
public static String getType(Property property, MarkupLanguage markupLanguage){
|
||||
Validate.notNull(property, "property must not be null!");
|
||||
String type;
|
||||
if(property instanceof RefProperty){
|
||||
RefProperty refProperty = (RefProperty)property;
|
||||
switch (markupLanguage){
|
||||
case ASCIIDOC: return "<<" + refProperty.getSimpleRef() + ">>";
|
||||
default: return refProperty.getSimpleRef();
|
||||
}
|
||||
}else if(property instanceof ArrayProperty){
|
||||
ArrayProperty arrayProperty = (ArrayProperty)property;
|
||||
Property items = arrayProperty.getItems();
|
||||
type = getType(items, markupLanguage) + " " + arrayProperty.getType();
|
||||
}else if(property instanceof StringProperty){
|
||||
StringProperty stringProperty = (StringProperty)property;
|
||||
List<String> enums = stringProperty.getEnum();
|
||||
if(CollectionUtils.isNotEmpty(enums)){
|
||||
type = "enum" + " (" + StringUtils.join(enums, ", ") + ")";
|
||||
}else{
|
||||
type = property.getType();
|
||||
}
|
||||
}
|
||||
else{
|
||||
if(StringUtils.isNotBlank(property.getFormat())){
|
||||
type = property.getType() + " (" + property.getFormat() + ")";
|
||||
}else{
|
||||
type = property.getType();
|
||||
}
|
||||
}
|
||||
return type;
|
||||
}
|
||||
}
|
||||
@@ -1,12 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<configuration scan="true">
|
||||
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
|
||||
<encoder>
|
||||
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
|
||||
</encoder>
|
||||
</appender>
|
||||
|
||||
<root level="DEBUG">
|
||||
<appender-ref ref="CONSOLE" />
|
||||
</root>
|
||||
</configuration>
|
||||
@@ -1,66 +0,0 @@
|
||||
package io.github.robwin.swagger2markup;
|
||||
|
||||
import io.github.robwin.markup.builder.MarkupLanguage;
|
||||
import org.asciidoctor.*;
|
||||
import org.junit.Test;
|
||||
|
||||
import java.io.BufferedWriter;
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Paths;
|
||||
|
||||
/**
|
||||
* @author Robert Winkler
|
||||
*/
|
||||
public class Swagger2MarkupConverterTest {
|
||||
|
||||
@Test
|
||||
public void testSwagger2MarkupConversion() throws IOException {
|
||||
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/swagger.json").getFile());
|
||||
|
||||
Swagger2MarkupConverter.from(file.getAbsolutePath()).
|
||||
withMarkupLanguage(MarkupLanguage.MARKDOWN).
|
||||
withExamples("docs").withSchemas("docs/schemas").build()
|
||||
.intoFolder("src/docs/markdown");
|
||||
|
||||
Swagger2MarkupConverter.from(file.getAbsolutePath()).
|
||||
withExamples("docs").withSchemas("docs/schemas").build()
|
||||
.intoFolder("src/docs/asciidoc");
|
||||
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testSwagger2HtmlConversion() throws IOException {
|
||||
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/swagger.json").getFile());
|
||||
String asciiDoc = Swagger2MarkupConverter.from(file.getAbsolutePath()).build().asString();
|
||||
String path = "src/docs/asciidocAsString";
|
||||
Files.createDirectories(Paths.get(path));
|
||||
try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(path, "swagger.adoc"), StandardCharsets.UTF_8)){
|
||||
writer.write(asciiDoc); }
|
||||
String asciiDocAsHtml = Asciidoctor.Factory.create().convert(asciiDoc,
|
||||
OptionsBuilder.options().backend("html5").headerFooter(true).safe(SafeMode.UNSAFE).docType("book").attributes(AttributesBuilder.attributes()
|
||||
.tableOfContents(true).tableOfContents(Placement.LEFT).sectionNumbers(true).hardbreaks(true).setAnchors(true).attribute("sectlinks")));
|
||||
try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(path, "swagger.html"), StandardCharsets.UTF_8)){
|
||||
writer.write(asciiDocAsHtml);
|
||||
}
|
||||
}
|
||||
/*
|
||||
@Test
|
||||
public void testSwagger2PdfConversion() throws IOException {
|
||||
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/spica.json").getFile());
|
||||
String asciiDoc = Swagger2MarkupConverter.from(file.getAbsolutePath()).build().asString();
|
||||
String path = "src/docs/asciidocAsString";
|
||||
Files.createDirectories(Paths.get(path));
|
||||
try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(path, "spica.adoc"), StandardCharsets.UTF_8)){
|
||||
writer.write(asciiDoc);
|
||||
}
|
||||
String asciiDocAsPdf= Asciidoctor.Factory.create().convert(asciiDoc, OptionsBuilder.options().backend("pdf"));
|
||||
try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(path, "spica.pdf"), StandardCharsets.UTF_8)){
|
||||
writer.write(asciiDocAsPdf);
|
||||
}
|
||||
}
|
||||
*/
|
||||
|
||||
}
|
||||
@@ -1,846 +0,0 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"description": "This is a sample server Petstore server.\n\n[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.\n\nFor this sample, you can use the api key `special-key` to test the authorization filters\n",
|
||||
"version": "1.0.0",
|
||||
"title": "Swagger Petstore",
|
||||
"termsOfService": "http://helloreverb.com/terms/",
|
||||
"contact": {
|
||||
"name": "apiteam@wordnik.com"
|
||||
},
|
||||
"license": {
|
||||
"name": "Apache 2.0",
|
||||
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
|
||||
}
|
||||
},
|
||||
"host": "petstore.swagger.wordnik.com",
|
||||
"basePath": "/v2",
|
||||
"schemes": [
|
||||
"http"
|
||||
],
|
||||
"paths": {
|
||||
"/pets": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"pet"
|
||||
],
|
||||
"summary": "Add a new pet to the store",
|
||||
"description": "",
|
||||
"operationId": "addPet",
|
||||
"consumes": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"description": "Pet object that needs to be added to the store",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/Pet"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"405": {
|
||||
"description": "Invalid input"
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"petstore_auth": [
|
||||
"write_pets",
|
||||
"read_pets"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"put": {
|
||||
"tags": [
|
||||
"pet"
|
||||
],
|
||||
"summary": "Update an existing pet",
|
||||
"description": "",
|
||||
"operationId": "updatePet",
|
||||
"consumes": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"description": "Pet object that needs to be added to the store",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/Pet"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"400": {
|
||||
"description": "Invalid ID supplied"
|
||||
},
|
||||
"404": {
|
||||
"description": "Pet not found"
|
||||
},
|
||||
"405": {
|
||||
"description": "Validation exception"
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"petstore_auth": [
|
||||
"write_pets",
|
||||
"read_pets"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/pets/findByStatus": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"pet"
|
||||
],
|
||||
"summary": "Finds Pets by status",
|
||||
"description": "Multiple status values can be provided with comma seperated strings",
|
||||
"operationId": "findPetsByStatus",
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"name": "status",
|
||||
"description": "Status values that need to be considered for filter",
|
||||
"required": false,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"collectionFormat": "multi"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "successful operation",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/Pet"
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Invalid status value"
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"petstore_auth": [
|
||||
"write_pets",
|
||||
"read_pets"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/pets/findByTags": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"pet"
|
||||
],
|
||||
"summary": "Finds Pets by tags",
|
||||
"description": "Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.",
|
||||
"operationId": "findPetsByTags",
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"name": "tags",
|
||||
"description": "Tags to filter by",
|
||||
"required": false,
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"collectionFormat": "multi"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "successful operation",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/Pet"
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Invalid tag value"
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"petstore_auth": [
|
||||
"write_pets",
|
||||
"read_pets"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/pets/{petId}": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"pet"
|
||||
],
|
||||
"summary": "Find pet by ID",
|
||||
"description": "Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions",
|
||||
"operationId": "getPetById",
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "petId",
|
||||
"description": "ID of pet that needs to be fetched",
|
||||
"required": true,
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "successful operation",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/Pet"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Invalid ID supplied"
|
||||
},
|
||||
"404": {
|
||||
"description": "Pet not found"
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"api_key": []
|
||||
},
|
||||
{
|
||||
"petstore_auth": [
|
||||
"write_pets",
|
||||
"read_pets"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"post": {
|
||||
"tags": [
|
||||
"pet"
|
||||
],
|
||||
"summary": "Updates a pet in the store with form data",
|
||||
"description": "",
|
||||
"operationId": "updatePetWithForm",
|
||||
"consumes": [
|
||||
"application/x-www-form-urlencoded"
|
||||
],
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "petId",
|
||||
"description": "ID of pet that needs to be updated",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "formData",
|
||||
"name": "name",
|
||||
"description": "Updated name of the pet",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "formData",
|
||||
"name": "status",
|
||||
"description": "Updated status of the pet",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"405": {
|
||||
"description": "Invalid input"
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"petstore_auth": [
|
||||
"write_pets",
|
||||
"read_pets"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"tags": [
|
||||
"pet"
|
||||
],
|
||||
"summary": "Deletes a pet",
|
||||
"description": "",
|
||||
"operationId": "deletePet",
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "header",
|
||||
"name": "api_key",
|
||||
"description": "",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "path",
|
||||
"name": "petId",
|
||||
"description": "Pet id to delete",
|
||||
"required": true,
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"400": {
|
||||
"description": "Invalid pet value"
|
||||
}
|
||||
},
|
||||
"security": [
|
||||
{
|
||||
"petstore_auth": [
|
||||
"write_pets",
|
||||
"read_pets"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"/stores/order": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"store"
|
||||
],
|
||||
"summary": "Place an order for a pet",
|
||||
"description": "",
|
||||
"operationId": "placeOrder",
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"description": "order placed for purchasing the pet",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/Order"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "successful operation",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/Order"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Invalid Order"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/stores/order/{orderId}": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"store"
|
||||
],
|
||||
"summary": "Find purchase order by ID",
|
||||
"description": "For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions",
|
||||
"operationId": "getOrderById",
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "orderId",
|
||||
"description": "ID of pet that needs to be fetched",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "successful operation",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/Order"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Invalid ID supplied"
|
||||
},
|
||||
"404": {
|
||||
"description": "Order not found"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"tags": [
|
||||
"store"
|
||||
],
|
||||
"summary": "Delete purchase order by ID",
|
||||
"description": "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
|
||||
"operationId": "deleteOrder",
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "orderId",
|
||||
"description": "ID of the order that needs to be deleted",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"400": {
|
||||
"description": "Invalid ID supplied"
|
||||
},
|
||||
"404": {
|
||||
"description": "Order not found"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/users": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Create user",
|
||||
"description": "This can only be done by the logged in user.",
|
||||
"operationId": "createUser",
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"description": "Created user object",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/User"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"default": {
|
||||
"description": "successful operation"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/users/createWithArray": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Creates list of users with given input array",
|
||||
"description": "",
|
||||
"operationId": "createUsersWithArrayInput",
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"description": "List of user object",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/User"
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"default": {
|
||||
"description": "successful operation"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/users/createWithList": {
|
||||
"post": {
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Creates list of users with given input array",
|
||||
"description": "",
|
||||
"operationId": "createUsersWithListInput",
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"description": "List of user object",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/User"
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"default": {
|
||||
"description": "successful operation"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/users/login": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Logs user into the system",
|
||||
"description": "",
|
||||
"operationId": "loginUser",
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"name": "username",
|
||||
"description": "The user name for login",
|
||||
"required": false,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "password",
|
||||
"description": "The password for login in clear text",
|
||||
"required": false,
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "successful operation",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Invalid username/password supplied"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/users/logout": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Logs out current logged in user session",
|
||||
"description": "",
|
||||
"operationId": "logoutUser",
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"responses": {
|
||||
"default": {
|
||||
"description": "successful operation"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/users/{username}": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Get user by user name",
|
||||
"description": "",
|
||||
"operationId": "getUserByName",
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "username",
|
||||
"description": "The name that needs to be fetched. Use user1 for testing.",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "successful operation",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/User"
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Invalid username supplied"
|
||||
},
|
||||
"404": {
|
||||
"description": "User not found"
|
||||
}
|
||||
}
|
||||
},
|
||||
"put": {
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Updated user",
|
||||
"description": "This can only be done by the logged in user.",
|
||||
"operationId": "updateUser",
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "username",
|
||||
"description": "name that need to be deleted",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
{
|
||||
"in": "body",
|
||||
"name": "body",
|
||||
"description": "Updated user object",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/User"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"400": {
|
||||
"description": "Invalid user supplied"
|
||||
},
|
||||
"404": {
|
||||
"description": "User not found"
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"tags": [
|
||||
"user"
|
||||
],
|
||||
"summary": "Delete user",
|
||||
"description": "This can only be done by the logged in user.",
|
||||
"operationId": "deleteUser",
|
||||
"produces": [
|
||||
"application/json",
|
||||
"application/xml"
|
||||
],
|
||||
"parameters": [
|
||||
{
|
||||
"in": "path",
|
||||
"name": "username",
|
||||
"description": "The name that needs to be deleted",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"400": {
|
||||
"description": "Invalid username supplied"
|
||||
},
|
||||
"404": {
|
||||
"description": "User not found"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"securityDefinitions": {
|
||||
"api_key": {
|
||||
"type": "apiKey",
|
||||
"name": "api_key",
|
||||
"in": "header"
|
||||
},
|
||||
"petstore_auth": {
|
||||
"type": "oauth2",
|
||||
"authorizationUrl": "http://petstore.swagger.wordnik.com/api/oauth/dialog",
|
||||
"flow": "implicit",
|
||||
"scopes": {
|
||||
"write_pets": "modify pets in your account",
|
||||
"read_pets": "read your pets"
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"User": {
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
},
|
||||
"username": {
|
||||
"type": "string"
|
||||
},
|
||||
"firstName": {
|
||||
"type": "string"
|
||||
},
|
||||
"lastName": {
|
||||
"type": "string"
|
||||
},
|
||||
"email": {
|
||||
"type": "string"
|
||||
},
|
||||
"password": {
|
||||
"type": "string"
|
||||
},
|
||||
"phone": {
|
||||
"type": "string"
|
||||
},
|
||||
"userStatus": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "User Status"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Category": {
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Pet": {
|
||||
"required": [
|
||||
"name",
|
||||
"photoUrls"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
},
|
||||
"category": {
|
||||
"$ref": "#/definitions/Category"
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"example": "doggie"
|
||||
},
|
||||
"photoUrls": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"tags": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/Tag"
|
||||
}
|
||||
},
|
||||
"status": {
|
||||
"type": "string",
|
||||
"description": "pet status in the store"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Tag": {
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Order": {
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
},
|
||||
"petId": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
},
|
||||
"quantity": {
|
||||
"type": "integer",
|
||||
"format": "int32"
|
||||
},
|
||||
"shipDate": {
|
||||
"type": "string",
|
||||
"format": "date-time"
|
||||
},
|
||||
"status": {
|
||||
"type": "string",
|
||||
"description": "Order Status"
|
||||
},
|
||||
"complete": {
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||