Compare commits

...

224 Commits

Author SHA1 Message Date
Robert Winkler
9d387b3e80 Merge remote-tracking branch 'origin/master' 2015-11-09 14:52:52 +01:00
Robert Winkler
1e6be2f26d Updated swagger-parser from v1.0.8 to v1.0.13
Support for global responses and parameters
2015-11-09 14:52:43 +01:00
Robert Winkler
e56f824cd2 Updated documentation 2015-10-01 08:40:44 +02:00
Robert Winkler
d38014f4b5 Updated documentation 2015-09-30 13:35:12 +02:00
Robert Winkler
b331062fa6 Updated documentation 2015-09-01 17:28:13 +02:00
Robert Winkler
88df748451 Merge pull request #35 from Relequestual/patch-1
Updated readme to better reflect alternatives listing
2015-09-01 17:19:44 +02:00
Ben Hutton
5384197bd1 Updated readme to better reflect alternatives listing
The list of alternative publishing libraries was missleading in the sense it lead me to believe that I could use this library to generate AsciiDoc or Markdown, which would work in all of the listed documentation hosting services / open source projects templates.
2015-09-01 14:53:22 +01:00
Robert Winkler
2b5d4b7fe9 Merge pull request #34 from johanhammar/urischeme
Do not render URI scheme if none of host, schemes or basePath are set
2015-08-29 01:32:59 +02:00
Johan Hammar
c15d074488 Do not render URI scheme if none of host, schemes or basePath are set 2015-08-28 22:18:49 +02:00
Robert Winkler
b0c3aa71b9 Merge pull request #32 from johanhammar/gradle25
Update the dependency-management-plugin to work with Gradle 2.5
2015-08-26 21:15:17 +02:00
Johan Hammar
32d85ffb55 Update the dependency-management-plugin to work with Gradle 2.5 2015-08-26 20:56:23 +02:00
Robert Winkler
59fcd61738 Updated documentation 2015-08-24 20:55:30 +02:00
Robert Winkler
7ce969882d Updated documentation 2015-08-24 20:54:39 +02:00
Robert Winkler
ee70cdb94f Update README.adoc 2015-08-24 20:52:32 +02:00
Robert Winkler
f21fce7730 * Enhancement #26 and #27: Added a pre-process hook to modify a Swagger Model before it is converted. 2015-08-24 20:44:46 +02:00
Robert Winkler
c426c7b341 Bugfix #29: Tags are rendered twice 2015-08-24 20:44:17 +02:00
Robert Winkler
1231d1e0c2 Merge pull request #27 from zmitrok/master
Added a hook to pre-process Swagger model before generating the marku…
2015-08-21 18:13:18 +02:00
zmitrok
66073aebb8 Added a hook to pre-process Swagger model before generating the markup. This approach heavily relies on the mutability of the Swagger class 2015-08-20 23:57:46 -07:00
Robert Winkler
882d9e5709 Merge pull request #23 from izeye/patch-1
Fix a broken link
2015-07-24 17:08:27 +02:00
izeye
ba9ec45d9e Fix a broken link 2015-07-24 21:07:36 +09:00
Robert Winkler
f2787a41ae Merge branch 'master' of https://github.com/Swagger2Markup/swagger2markup 2015-07-20 08:20:41 +02:00
Robert Winkler
3469523225 Workaround: If the type of a BodyParameter is String and not a Model, the schema is null and lost. Therefore the fallback type of a BodyParameter is String now. 2015-07-20 08:20:06 +02:00
Robert Winkler
1dc9a07cb9 Updated documentation 2015-07-14 08:33:46 +02:00
Robert Winkler
a34807e5c9 Updated Travis-CI Batch 2015-07-09 08:08:57 +02:00
Robert Winkler
85ef33a720 Updated documentation 2015-07-06 08:49:22 +02:00
Robert Winkler
3163c077a1 Updated documentation 2015-06-30 08:39:46 +02:00
Robert Winkler
fbb446875d Updated documentation 2015-06-30 08:38:54 +02:00
Robert Winkler
e8cdcabffe Updated documentation 2015-06-30 08:36:08 +02:00
Robert Winkler
832813d40a Updated documentation 2015-06-30 08:26:05 +02:00
Robert Winkler
e2f28bca7d Updated documentation 2015-06-29 15:29:06 +02:00
Robert Winkler
3ed894688c Updated documentation 2015-06-29 12:33:52 +02:00
Robert Winkler
bb7422d755 New Feature #21: Added support for both reference models and composed models 2015-06-29 09:32:47 +02:00
Robert Winkler
b2f3f4a6c7 Updated documentation 2015-06-28 09:02:09 +02:00
Robert Winkler
f21794a253 Updated documentation 2015-06-27 11:49:19 +02:00
Robert Winkler
ffa96e56a5 Updated documentation 2015-06-27 11:47:49 +02:00
Robert Winkler
38e50dfe77 Merge pull request #20 from redowl/add-composition-support
Adding support for composed model definitions
2015-06-27 11:38:20 +02:00
Russell Snyder
1d3ec2d5a3 Adding support for composed model definitions
Signed-off-by: Russell Snyder <russell@redowlanalytics.com>
2015-06-26 14:40:41 -04:00
Robert Winkler
495751433b Updated documentation 2015-06-24 19:32:23 +02:00
Robert Winkler
de7d73eae9 Updated documentation 2015-06-24 09:54:33 +02:00
Robert Winkler
f825cf9613 Updated documentation 2015-06-24 09:53:47 +02:00
Robert Winkler
6e32056c26 Updated documentation 2015-06-24 09:44:51 +02:00
Robert Winkler
85bc2aa8f9 Updated documentation 2015-06-23 09:44:07 +02:00
Robert Winkler
d56de83368 Updated documentation 2015-06-23 09:41:36 +02:00
Robert Winkler
065e65a31c Updated documentation 2015-06-23 09:38:33 +02:00
Robert Winkler
a68980bc76 Updated documentation 2015-06-23 09:32:47 +02:00
Robert Winkler
90880a00f3 Added possibility to write object definitions to separate files. Issue #19 2015-06-23 09:24:15 +02:00
Robert Winkler
675dd762a8 Merge pull request #19 from sg-ad/SplitDefinitionFiles
Adding possibility to write object definitions to separate files.
2015-06-23 08:45:25 +02:00
Sebastien Gagnon
7cdd436b10 Add possibility to write object definitions to separate files. 2015-06-22 16:30:05 -04:00
Robert Winkler
a78126c551 Added twitter batch 2015-06-16 08:29:50 +02:00
Robert Winkler
f729bf15c3 Added gitter hook 2015-06-10 12:42:02 +02:00
Robert Winkler
ce129703f8 Updated documentation 2015-06-10 09:09:59 +02:00
Robert Winkler
c99bba90a4 Updated swagger-parser from v1.0.6 to v1.0.8 2015-06-10 08:57:29 +02:00
Robert Winkler
914a8ed5fb Merge remote-tracking branch 'origin/master' 2015-06-08 08:51:37 +02:00
Robert Winkler
85b95c189e Updated swagger-parser from v1.0.6 to v1.0.8 2015-06-08 08:51:19 +02:00
Robert Winkler
8722bdc8cb Delete SUMMARY..adoc 2015-05-27 20:12:42 +02:00
Robert Winkler
2ce724cdd0 Update null 2015-05-27 20:08:08 +02:00
Robert Winkler
922b6b8534 Create SUMMARY..adoc 2015-05-27 20:07:51 +02:00
Robert Winkler
a05f4b2e29 Update README.adoc 2015-05-27 20:05:06 +02:00
Robert Winkler
e4e32f3f9f Updated documentation 2015-05-21 11:05:07 +02:00
Robert Winkler
bf0b864c0d * Updated swagger-parser from v1.0.5 to v1.0.6
* Support for default values in Parameters and Model properties
2015-05-21 11:00:02 +02:00
Robert Winkler
4948c8bea1 * Swagger License is not mandatory anymore
* Updated markup-document-builder from v0.1.3 to v0.1.4
2015-05-20 10:12:21 +02:00
Robert Winkler
9397bf4255 Merge remote-tracking branch 'origin/master' 2015-05-18 12:40:13 +02:00
Robert Winkler
a6d85d7b0c * Swagger License is not mandatory anymore
* Updated markup-document-builder from v0.1.3 to v0.1.4
2015-05-18 12:40:05 +02:00
Robert Winkler
16371443e8 Updated documentation 2015-05-11 07:18:43 +02:00
Robert Winkler
5738d86988 Updated documentation 2015-05-11 07:05:38 +02:00
Robert Winkler
e1bf3fbe94 Updated documentation 2015-05-10 20:11:23 +02:00
Robert Winkler
7ce98408f4 Updated documentation 2015-05-10 20:07:07 +02:00
Robert Winkler
1a7b219c40 Updated documentation 2015-05-10 20:02:37 +02:00
Robert Winkler
8a8e93f3ca Updated documentation 2015-05-08 21:36:58 +02:00
Robert Winkler
1d95d9afc2 Updates documentation 2015-05-07 11:42:37 +02:00
Robert Winkler
5b49187cb7 Updated documentation 2015-05-06 09:11:33 +02:00
Robert Winkler
7b99565636 Updated documentation 2015-05-06 09:07:19 +02:00
Robert Winkler
32980d1476 Updated documentation 2015-05-06 09:05:04 +02:00
Robert Winkler
490a6d974f Updated documentation 2015-05-06 08:52:53 +02:00
Robert Winkler
4e971817a2 Updated documentation 2015-05-06 08:51:20 +02:00
Robert Winkler
f649553727 Updated documentation 2015-05-05 16:26:28 +02:00
Robert Winkler
3576a80872 Added Swagger2Markup Gradle Plugin 2015-05-05 15:59:54 +02:00
Robert Winkler
2bbb9ffd8e Merge remote-tracking branch 'origin/master' 2015-05-05 14:02:35 +02:00
Robert Winkler
7d2acae537 Bugfix: Definition name must be lowercase so that descriptions file can be found 2015-05-05 14:02:26 +02:00
Robert Winkler
1e68587097 Updates documentation 2015-05-05 10:35:34 +02:00
Robert Winkler
71d77ce6ab Updates documentation 2015-05-05 10:16:13 +02:00
Robert Winkler
de849b69d4 Updates documentation 2015-05-05 10:12:00 +02:00
Robert Winkler
a8e84995ea Updated documentation 2015-05-04 16:52:05 +02:00
Robert Winkler
edffd47067 Updated documentation 2015-05-04 16:51:30 +02:00
Robert Winkler
cef474955e Updated documentation 2015-05-04 16:49:33 +02:00
Robert Winkler
00dffe7b57 Updated documentation 2015-05-04 16:47:13 +02:00
Robert Winkler
fea79bd4f9 Updated documentation 2015-05-04 16:46:03 +02:00
Robert Winkler
fb5d30f700 Updated documentation 2015-05-04 16:43:36 +02:00
Robert Winkler
ab15b393d0 Support for including hand-written descriptions instead of using Swagger Annotations for descriptions 2015-05-04 16:05:00 +02:00
Robert Winkler
7d1cf12c48 Merge branch 'master' of https://github.com/RobWin/swagger2markup 2015-05-04 15:47:19 +02:00
Robert Winkler
14d8acc385 Support for including hand-written descriptions instead of using Swagger Annotations for descriptions 2015-05-04 15:46:30 +02:00
Robert Winkler
e91d639d93 Updates documentation 2015-05-04 11:55:02 +02:00
Robert Winkler
3671873349 Updates documentation 2015-05-04 10:50:15 +02:00
Robert Winkler
f920a3e954 Updates documentation 2015-05-04 10:47:24 +02:00
Robert Winkler
cb35f1f319 Updates documentation 2015-05-04 10:46:45 +02:00
Robert Winkler
c8805f5018 Updates documentation 2015-05-04 10:46:20 +02:00
Robert Winkler
cc04be6790 Updated documentation 2015-05-04 07:06:16 +02:00
Robert Winkler
13eb453c2a Updated documentation 2015-05-04 07:05:25 +02:00
Robert Winkler
d20dfa9027 Updated documentation 2015-05-04 06:55:52 +02:00
Robert Winkler
38429152f2 Updated documentation 2015-05-03 16:24:57 +02:00
Robert Winkler
cf382e9890 Updated documentation 2015-05-03 16:22:40 +02:00
Robert Winkler
81b1846fcd Updated documentation 2015-05-03 14:57:57 +02:00
Robert Winkler
7d48a65ec1 Updated documentation 2015-05-03 14:55:07 +02:00
Robert Winkler
dc50cdff15 Updated documentation 2015-05-03 14:51:43 +02:00
Robert Winkler
165e615698 Updated documentation 2015-05-03 14:46:43 +02:00
Robert Winkler
2559bef4ce Updated documentation 2015-05-03 14:43:01 +02:00
Robert Winkler
7847a74104 Updated documentation 2015-05-03 14:41:47 +02:00
Robert Winkler
685596c213 Updated documentation 2015-05-01 19:30:42 +02:00
Robert Winkler
20862d3ee4 Updated documentation 2015-04-30 20:41:52 +02:00
Robert Winkler
2527792b58 Updated documentation 2015-04-29 11:34:31 +02:00
Robert Winkler
d85d307e30 Updated documentation 2015-04-24 12:52:30 +02:00
Robert Winkler
58e01e96e1 Updated documentation 2015-04-24 08:29:25 +02:00
Robert Winkler
1b425b83b6 Merge remote-tracking branch 'origin/master' 2015-04-24 08:27:04 +02:00
Robert Winkler
96d7195365 Added Apache2 Copyright Header 2015-04-24 08:26:48 +02:00
Robert Winkler
e14af63a4c Updated documentation 2015-04-23 19:33:52 +02:00
Robert Winkler
925f1a1f81 Updated documentation 2015-04-23 16:28:45 +02:00
Robert Winkler
1e5e2b20dd Updated documentation 2015-04-23 15:56:03 +02:00
Robert Winkler
d209718987 Updated documentation 2015-04-22 13:55:38 +02:00
Robert Winkler
31619b26c9 Updated documentation 2015-04-21 14:04:42 +02:00
Robert Winkler
2277c7410b Updated documentation 2015-04-21 14:03:30 +02:00
Robert Winkler
90d8b088d2 Updated documentation 2015-04-21 14:02:45 +02:00
Robert Winkler
a5d9588a7d Updated documentation 2015-04-21 14:02:29 +02:00
Robert Winkler
ff17b1d857 Updated documentation 2015-04-21 13:52:56 +02:00
Robert Winkler
2a5bd83bb8 Updated documentation 2015-04-21 08:57:35 +02:00
Robert Winkler
aa7800ba37 Updated documentation 2015-04-21 08:56:58 +02:00
Robert Winkler
8a1a1a9d91 Updated documentation 2015-04-21 08:36:38 +02:00
Robert Winkler
e7b59f8a2f Updated documentation 2015-04-21 08:33:24 +02:00
Robert Winkler
8e75655346 Updated documentation 2015-04-21 08:31:31 +02:00
Robert Winkler
e45498a1d7 Updated documentation 2015-04-21 08:25:03 +02:00
Robert Winkler
5f838ca2b4 Updated documentation 2015-04-21 08:22:44 +02:00
Robert Winkler
85e53ce89f Updated documentation 2015-04-20 22:09:37 +02:00
Robert Winkler
51c1cd3fe5 Updated documentation 2015-04-20 17:00:15 +02:00
Robert Winkler
29c7db1980 Updated documentation 2015-04-20 16:53:45 +02:00
Robert Winkler
663323cd1e Updated documentation 2015-04-20 16:50:37 +02:00
Robert Winkler
ab13a6ec0e Updated documentation 2015-04-20 16:44:37 +02:00
Robert Winkler
d78eb490cb Updated documentation 2015-04-20 16:42:59 +02:00
Robert Winkler
48e724cb4b Updated documentation 2015-04-20 16:09:39 +02:00
Robert Winkler
0a3db6c013 Updated documentation 2015-04-20 16:08:42 +02:00
Robert Winkler
a843fad921 Fixed unit test issue 2015-04-20 15:50:41 +02:00
Robert Winkler
de41e3b058 Updated documentation 2015-04-20 15:42:45 +02:00
Robert Winkler
6bf3a5aab4 Updated documentation 2015-04-20 15:38:46 +02:00
Robert Winkler
8d4bc8c0bc == Version 0.4.0
* Updated Swagger-Parser from 1.0.0 to 1.0.5
* Updated commons-lang to commons-lang3
* Swagger2MarkupConverter generates three documents now: overview, paths and definitions
* Support for enums in HeaderParameter, QueryParameter, FormParameter and QueryParameter
* Support for global consumes, produces and tags
2015-04-20 15:35:37 +02:00
Robert Winkler
76df322bb4 Updated documentation 2015-04-18 20:35:41 +02:00
Robert Winkler
36cdd3cebb Updated documentation 2015-04-18 20:08:36 +02:00
Robert Winkler
ca4587cb29 Updated documentation 2015-04-18 20:05:11 +02:00
Robert Winkler
ce958ba798 Updated documentation 2015-04-18 20:02:49 +02:00
Robert Winkler
7c5c0fea8c Updated documentation 2015-04-18 13:39:57 +02:00
Robert Winkler
5bc557a5d2 Updated documentation 2015-04-18 13:38:02 +02:00
Robert Winkler
e23a649c17 Updated documentation 2015-04-18 13:36:56 +02:00
Robert Winkler
a5300ceab5 Updated documentation 2015-04-18 13:22:49 +02:00
Robert Winkler
fdb405e52a Updated documentation 2015-04-18 13:03:25 +02:00
Robert Winkler
79cdd26ef0 Updated documentation 2015-04-18 12:52:49 +02:00
Robert Winkler
87c24c8f31 Updated documentation 2015-04-18 11:03:17 +02:00
Robert Winkler
6216165515 Updated documentation 2015-04-18 10:59:51 +02:00
Robert Winkler
77640d21be Updates documentation 2015-04-18 08:28:10 +02:00
Robert Winkler
57282f4933 Updated documentation 2015-04-17 14:19:41 +02:00
Robert Winkler
1a12e0dc11 Updated documentation 2015-04-17 14:16:21 +02:00
Robert Winkler
2b0317d1f6 Updated documentation 2015-04-17 14:10:41 +02:00
Robert Winkler
8fce706f31 Updated documentation 2015-04-17 14:06:08 +02:00
Robert Winkler
ae0f3ab31d Updated documentation 2015-04-17 14:01:27 +02:00
Robert Winkler
34cb438757 Updated documentation 2015-04-17 13:58:29 +02:00
Robert Winkler
8747ba2c1d Updated documentation 2015-04-17 13:57:10 +02:00
Robert Winkler
bef4e3c735 Updated documentation 2015-04-17 13:55:14 +02:00
Robert Winkler
6396b8fdb7 * Support of YAML or JSON String as input. 2015-04-17 13:25:26 +02:00
Robert Winkler
e27ba4304d * Fixed issue #8: logback.xml on the classpath
* Fixed issue #13: unknown format not supported for properties
2015-04-16 12:17:40 +02:00
Robert Winkler
4c86e73c4e * Fixed issue #8: logback.xml on the classpath
* Fixed issue #13: unknown format not supported for properties
2015-04-16 12:15:37 +02:00
Robert Winkler
9f9fa8c444 Added springfox 2015-04-15 17:03:37 +02:00
Robert Winkler
9647116572 Added springfox 2015-04-15 17:01:45 +02:00
Robert Winkler
736891fbdd Merge branch 'master' of https://github.com/RobWin/swagger2markup 2015-04-15 16:40:58 +02:00
Robert Winkler
acec733af7 Added docs folder 2015-04-15 16:34:45 +02:00
Robert Winkler
73cdc35c80 Fixed issue: ResponseModel from api declaration is not rendered
Fixed issue: @ApiModelProperty metadata are ignored for definitions file
Fixed issue: logback.xml on the classpath
2015-04-15 16:32:22 +02:00
Robert Winkler
cae91b3565 Merge remote-tracking branch 'origin/develop' into develop 2015-04-15 16:30:51 +02:00
Robert Winkler
ec610f4fbb Fixed issue: ResponseModel from api declaration is not rendered
Fixed issue: @ApiModelProperty metadata are ignored for definitions file
Fixed issue: logback.xml on the classpath
2015-04-15 16:30:37 +02:00
Robert Winkler
edf9ba01bd Merge pull request #12 from RobWin/develop
Added Gitter badge
2015-04-08 08:42:29 +02:00
Robert Winkler
e942252d9a Added Gitter badge 2015-04-08 08:35:41 +02:00
Robert Winkler
04d1773c03 Fixed markup-document-builder version dependency 2015-03-23 09:02:43 +01:00
Robert Winkler
448899c193 Merge branch 'release/0.2.2' 2015-03-23 09:00:20 +01:00
Robert Winkler
23d1db4fd5 Fixed markup-document-builder version dependency 2015-03-23 08:59:49 +01:00
Robert Winkler
903d3ed452 Merge pull request #3 from RobWin/master
fixed wrong dependency
2015-03-17 12:11:42 +01:00
Robert Winkler
1ad78ba9f6 fixed wrong dependency 2015-03-17 12:01:38 +01:00
Robert Winkler
82416a33cc Fixed maven POM issue 2015-02-20 11:02:23 +01:00
Robert Winkler
e67b32d537 Merge branch 'master' of https://github.com/RobWin/swagger2markup 2015-02-20 10:13:32 +01:00
Robert Winkler
dbb6f9ace8 Merge branch 'release/0.2.1' 2015-02-20 10:13:01 +01:00
Robert Winkler
19384f97b9 Published to Maven Central 2015-02-20 10:12:28 +01:00
Robert Winkler
90de0a3c6a Fixed build 2015-02-20 09:54:56 +01:00
Robert Winkler
ae77e814f7 Updated Bintry badge 2015-02-20 09:53:37 +01:00
Robert Winkler
d165a0f842 Added GPG Signing and Maven Central Sync 2015-02-20 09:47:47 +01:00
Robert Winkler
0833a74c37 Updated documentation 2015-02-20 08:50:36 +01:00
Robert Winkler
4ec7ecf25b Updated documentation 2015-02-20 08:46:30 +01:00
Robert Winkler
99dd062fc9 Added markup-document-builder library and removed Builder from project
Updated documentation
2015-02-20 08:41:17 +01:00
Robert Winkler
52462466ff Added markup-document-builder library 2015-02-20 08:24:09 +01:00
Robert Winkler
d2c69abb71 Updated wrong groupId 2015-02-19 20:22:28 +01:00
Robert Winkler
11d4311986 Updated documentation 2015-02-19 16:38:21 +01:00
Robert Winkler
e2f1bca8f1 Removed header 2015-02-19 15:48:17 +01:00
Robert Winkler
1db1af705b Updated documentation 2015-02-19 14:49:09 +01:00
Robert Winkler
dd140a532b Updated documentation 2015-02-19 14:17:56 +01:00
Robert Winkler
1f51a9bc91 Merge branch 'develop' 2015-02-19 14:15:16 +01:00
Robert Winkler
5f28eb4073 Updated documentation 2015-02-19 14:15:05 +01:00
Robert Winkler
97541bfc83 Updated documentation 2015-02-19 14:14:17 +01:00
Robert Winkler
9144155200 Merge branch 'develop' 2015-02-19 14:07:20 +01:00
Robert Winkler
84d64ec6f6 Updated documentation 2015-02-19 14:07:07 +01:00
Robert Winkler
e7c9ed54db Merge branch 'develop' 2015-02-19 11:59:39 +01:00
Robert Winkler
44838f0b6f Updated maven repository 2015-02-19 11:59:28 +01:00
Robert Winkler
d7efd403c7 Merge branch 'release/v0.2.0' 2015-02-19 11:38:31 +01:00
Robert Winkler
31a4c21aa1 Merge branch 'release/v0.2.0' into develop 2015-02-19 11:38:31 +01:00
Robert Winkler
6c50292563 Update version number to 0.2.0 2015-02-19 11:38:16 +01:00
Robert Winkler
3d116dd7f8 Updated version number 2015-02-19 11:09:24 +01:00
Robert Winkler
e6f7372c9f Updated documentation 2015-02-19 11:09:02 +01:00
Robert Winkler
0ca91ea930 Swagger2MarkupConverter refactored.
Supports examples and schemas includes now.
2015-02-19 10:48:41 +01:00
Robert Winkler
efea76d243 Updated documentation 2015-02-16 13:51:42 +01:00
Robert Winkler
cd4ef60cc3 Updated documentation 2015-02-16 12:55:38 +01:00
Robert Winkler
6ed557b4ac Updated documentation 2015-02-16 11:49:23 +01:00
Robert Winkler
139c294f25 Updated documentation 2015-02-16 11:40:58 +01:00
Robert Winkler
68a433b76b Updated documentation 2015-02-16 11:38:46 +01:00
Robert Winkler
b0dba05b48 Fixed documentation 2015-02-16 10:23:44 +01:00
Robert Winkler
55bb2bdd71 Added released version 2015-02-16 10:21:31 +01:00
Robert Winkler
3d4d87c0b0 Merge branch 'master' into develop 2015-02-16 10:02:17 +01:00
Robert Winkler
ad0d03c95c Fixed bintray set-up 2015-02-16 10:01:22 +01:00
Robert Winkler
0675beaa45 Merge branch 'release/v0.1.0' into develop 2015-02-16 09:52:44 +01:00
Robert Winkler
cb6526d0e5 Merge branch 'release/v0.1.0' 2015-02-16 09:52:44 +01:00
Robert Winkler
f5a8454817 Updated README 2015-02-16 09:17:44 +01:00
Robert Winkler
5bf8270f2e Fixed readme 2015-02-13 15:28:36 +01:00
Robert Winkler
6c794e75fd Fixed image links 2015-02-13 15:20:05 +01:00
Robert Winkler
b472bf97bb Fixed Image links 2015-02-13 15:15:22 +01:00
56 changed files with 2205 additions and 1777 deletions

View File

@@ -4,4 +4,12 @@ jdk:
before_install:
- chmod +x gradlew
after_success:
- ./gradlew jacocoTestReport coveralls
- ./gradlew jacocoTestReport coveralls
notifications:
webhooks:
urls:
- https://webhooks.gitter.im/e/9c620e84679284b7d621
on_success: change # options: [always|never|change] default: always
on_failure: always # options: [always|never|change] default: always
on_start: false # default: false
Your unique webhook url for this service:

View File

@@ -1,104 +1,64 @@
= Swagger2Markup
:author: Robert Winkler
:version: 0.1.0
: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:http://img.shields.io/:version-{version}-blue.svg["Semantic Versioning", link="http://semver.org"] 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://travis-ci.org/Swagger2Markup/swagger2markup.svg?branch=master["Build Status", link="https://travis-ci.org/Swagger2Markup/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://img.shields.io/badge/Twitter-rbrtwnklr-blue.svg["Twitter", link="https://twitter.com/rbrtwnklr"] 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"]
WARNING: Still under heavy development
== 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].
The primary goal of this project is to *simplify the generation of an up-to-date RESTful API documentation by combining documentation that's been hand-written with auto-generated API documentation* produced by https://github.com/swagger-api[Swagger]. The result is intended to be an *up-to-date, easy-to-read, on- and offline user guide*, comparable to https://developer.github.com/v3/[GitHub's API documentation]. The output of Swagger2Markup can be used as an alternative to https://github.com/swagger-api/swagger-ui[swagger-ui] and can be served as static content.
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 converts a Swagger JSON or YAML file into several *AsciiDoc* or *GitHub Flavored Markdown* documents which can be combined with hand-written documentation. The Swagger source file can be located locally or remotely via HTTP. Swagger2Markup 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].
== Usage
You can use Swagger2Markup to convert your contract-first Swagger YAML file into a human-readable format and combine it with hand-written documentation. As an alternative, you can choose the code-first approach and use Swagger2Markup together with https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-JAX-RS-Project-Setup-1.5.X[Swagger JAX-RS], https://github.com/springfox/springfox[springfox] or https://github.com/spring-projects/spring-restdocs[spring-restdocs]. If you are Gradle or Maven user, you can also use the https://github.com/RobWin/swagger2markup-gradle-plugin[Swagger2Markup Gradle Plugin] or https://github.com/redowl/swagger2markup-maven-plugin[Swagger2markup Maven Plugin].
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:
http://asciidoctor.org/docs/asciidoc-writers-guide/[AsciiDoc] is preferable to Markdown as it has more features. AsciiDoc is a text document format for writing documentation, articles, books, ebooks, slideshows, web pages and blogs. AsciiDoc files can be converted to *HTML*, *PDF* and *EPUB*. AsciiDoc is much better suited for describing public APIs than *JavaDoc* or *Annotations*.
[source,java]
----
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = SpringBootSwaggerConfig.class)
@IntegrationTest
@WebAppConfiguration
public class Swagger2MarkupTest {
You can generate your HTML5, PDF and EPUB 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/asciidoctor/asciidoctor-maven-plugin[asciidoctor-maven-plugin]. You can publish your AsciiDoc documentation using https://github.com/RobWin/asciidocular[Asciidocular]. Asciidocular is a small AngularJS web app that loads your AsciiDoc files via Ajax and renders them as a full web site.
@Test
public void convertSwaggerToMarkup() {
//Remote
Swagger2MarkupConverter.from("http://localhost:8080/api-docs").
toAsciiDoc("src/docs/asciidoc/example.adoc");
Advantages:
Swagger2MarkupConverter.from("http://localhost:8080/api-docs").
toMarkdown("src/docs/markdown/example.md");
* No server-side components needed to convert your AsciiDoc files into HTML
* No build process and tools needed
* Deployable via GitHub Pages
* Responsive Bootswatch (Bootstrap) theme
//Local
File file = new File(Swagger2MarkupTest.class.getResource("/json/swagger.json").getFile());
Swagger2MarkupConverter.from(file.getAbsolutePath()).toAsciiDoc("src/docs/asciidoc/swagger.adoc")
}
You can publish your Markdown documentation using https://github.com/jbake-org/jbake[JBake], https://github.com/tomchristie/mkdocs[MkDocs] or https://github.com/rtfd/readthedocs.org[ReadTheDocs].
}
----
The project requires at least JDK 7.
[source,java]
----
@SpringBootApplication
@EnableSwagger
public class SpringBootSwaggerConfig {
== Reference documentation
- http://swagger2markup.readme.io/[Reference Documentation]
- https://github.com/Swagger2Markup/swagger2markup/blob/master/RELEASENOTES.adoc[Release notes]
public static void main(String[] args) {
SpringApplication.run(SpringBootTestConfig.class, args);
}
== Contributing
@Autowired
private SpringSwaggerConfig springSwaggerConfig;
=== Community contributions
@Bean
public SwaggerSpringMvcPlugin customImplementation(){
return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
.apiInfo(apiInfo()).excludeAnnotations(Controller.class);
}
Pull requests are welcome.
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;
}
}
----
* New feature https://github.com/Swagger2Markup/swagger2markup/issues/18[RobWin/Swagger2Markup#18] by https://github.com/sg-ad[@sg-ad]: In addition to the definitions.adoc you can also generate separate files for each definition model (ex: person.adoc, address.adoc, purchase.adoc).
You can then generate 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] and https://github.com/aalmiray/markdown-gradle-plugin[markdown-gradle-plugin].
* New feature https://github.com/Swagger2Markup/swagger2markup/issues/21[RobWin/Swagger2Markup#21] by https://github.com/redowl[@redowl]: Support for both reference models and composed models.
== Example
== swagger.json
image::images/swagger_json.PNG[swagger_json]
* New feature https://github.com/Swagger2Markup/swagger2markup/issues/27[RobWin/Swagger2Markup#27] by https://github.com/zmitrok[@zmitrok]: Added a hook to preprocess a Swagger Model before it is converted.
=== Generated AsciiDoc file
image::images/asciidoc.PNG[asciidoc]
=== Questions
You can ask questions about Swagger2Markup in https://gitter.im/Swagger2Markup/swagger2markup[Gitter].
=== Generated Markdown file
image::images/markdown.PNG[asciidoc]
=== Bugs
If you believe you have found a bug, please take a moment to search the existing issues. If no one else has reported the problem, please open a new issue that describes the problem in detail and, ideally, includes a test that reproduces it.
=== Generated HTML
image::images/asciidoc_html.PNG[asciidoc_html]
=== Enhancements
If youd like an enhancement to be made to Swagger2Markup, pull requests are most welcome. The source code is on GitHub. You may want to search the existing issues and pull requests to see if the enhancement is already being worked on. You may also want to open a new issue to discuss a possible enhancement before work on it begins.
== Document Builder
The converter allows to build an AsciiDoc or Markdown document via the Builder pattern:
[source,java]
----
String asciiDoc = new AsciiDocBuilder().documentTitle("Title")
.sectionTitleLevel1("Section1").paragraph("Text text")
.sectionTitleLevel2("Code examples").listing("Code example").toString();
== License
String markdown = new MarkdownBuilder().documentTitle("Title")
.sectionTitleLevel1("Section1").paragraph("Text text")
.sectionTitleLevel2("Code examples").listing("Code example").toString();
----
Copyright 2015 Robert Winkler
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.

View File

@@ -1,4 +1,70 @@
= Release Notes
== Version 0.1.0
* Initial version with support for AsciiDoc and Markdown
* 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.2
* Fixed wrong dependency version to io.github.robwin:markup-document-builder
=== Version 0.2.3
* Fixed issue #7: @ApiModelProperty metadata are ignored for definitions file
=== Version 0.2.4
* Fixed issue #8: logback.xml on the classpath
* Fixed issue #13: unknown format not supported for properties
== Version 0.3.0
* Support of YAML or JSON String as input.
== Version 0.4.0
* Updated Swagger-Parser from 1.0.0 to 1.0.5
* Updated commons-lang to commons-lang3
* Swagger2MarkupConverter generates three documents now: overview, paths and definitions
* Support for enums in HeaderParameter, QueryParameter, FormParameter and QueryParameter
* Support for global consumes, produces and tags
== Version 0.5.0
* Support for including hand-written descriptions instead of using Swagger Annotations for descriptions
=== Version 0.5.1
* Bugfix: Definition name must be lowercase so that descriptions file can be found
=== Version 0.5.2
* Swagger License is not mandatory anymore
* Updated markup-document-builder from v0.1.3 to v0.1.4
=== Version 0.5.3
* Fixed compiler warning: [options] bootstrap class path not set in conjunction with -source 1.7
== Version 0.6.0
* Updated swagger-parser from v1.0.5 to v1.0.6
* Support for default values in Parameters and Model properties
=== Version 0.6.1
* Updated swagger-parser from v1.0.6 to v1.0.8
=== Version 0.6.2
* curl-request.adoc from spring-restdocs is also added to the example chapters
=== Version 0.6.3
* Added possibility to write object definitions to separate files. Issue #19
== Version 0.7.0
* Added support for both reference models and composed models
=== Version 0.7.1
* Workaround: If the type of a BodyParameter is String and not a Model, the schema is null and lost. Therefore the fallback type of a BodyParameter is String now.
== Version 0.8.0
* Enhancement #26 and #27: Added a pre-process hook to modify a Swagger Model before it is converted.
* Bugfix #29: Tags are rendered twice
=== Version 0.9.0
* Updated swagger-parser from v1.0.8 to v1.0.13
* Support for global responses and parameters

View File

@@ -5,23 +5,19 @@ buildscript {
}
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.3.1.RELEASE'
classpath 'org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.8'
classpath 'io.spring.gradle:dependency-management-plugin:0.5.3.RELEASE'
classpath 'org.kt3k.gradle.plugin:coveralls-gradle-plugin:2.0.1'
classpath 'me.champeau.gradle:jbake-gradle-plugin:0.2'
classpath 'org.jbake:jbake-core:2.3.2'
classpath 'org.asciidoctor:asciidoctorj:1.5.2'
classpath 'org.freemarker:freemarker:2.3.19'
classpath 'org.springframework.boot:spring-boot-gradle-plugin:1.2.1.RELEASE'
classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.0'
classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.2'
}
}
description = 'swagger2markup Build'
version = '0.1.0'
group = 'io.swagger2markup'
version = '0.9.0'
group = 'io.github.robwin'
apply plugin: 'java'
apply plugin: 'maven'
apply plugin: 'maven-publish'
apply plugin: 'org.asciidoctor.convert'
apply plugin: 'jacoco'
apply plugin: 'com.github.kt3k.coveralls'
@@ -44,26 +40,64 @@ repositories {
}
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 'org.slf4j:slf4j-api'
testCompile 'junit:junit'
testCompile 'org.asciidoctor:asciidoctorj:1.5.2'
testCompile 'ch.qos.logback:logback-classic'
testCompile 'org.assertj:assertj-core'
}
dependencyManagement {
dependencies {
"io.swagger:swagger-compat-spec-parser" "1.0.0"
"commons-collections:commons-collections" "3.2.1"
"com.mangofactory:swagger-springmvc" "0.9.5"
"com.jayway.restassured:spring-mock-mvc" "2.4.0"
"junit:junit" "4.11"
dependency "io.github.robwin:markup-document-builder:0.1.4"
dependency "io.swagger:swagger-compat-spec-parser:1.0.13"
dependency "commons-collections:commons-collections:3.2.1"
dependency "commons-io:commons-io:2.4"
dependency "junit:junit:4.11"
dependency "org.slf4j:slf4j-api:1.7.12"
dependency "ch.qos.logback:logback-classic:1.1.2"
dependency "org.assertj:assertj-core:2.0.0"
}
}
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
}
ext {
generatedDocumentation = file('build/docs/asciidoc/generated')
}
asciidoctor {
dependsOn test
sources {
include 'index.adoc'
}
backends = ['html5', 'pdf']
attributes = [
doctype: 'book',
toc: 'left',
toclevels: '1'
toclevels: '2',
numbered: '',
sectlinks: '',
sectanchors: '',
hardbreaks: '',
generated: generatedDocumentation
]
}
@@ -78,6 +112,10 @@ tasks.coveralls {
dependsOn 'check'
}
tasks.asciidoctor {
dependsOn 'check'
}
task wrapper(type: Wrapper) {
gradleVersion = '2.2.1'
}
gradleVersion = '2.4'
}

View File

@@ -25,9 +25,76 @@ jar {
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
pkg.repo = 'swagger2markup'
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
}
}
}

Binary file not shown.

View File

@@ -1,6 +1,6 @@
#Fri Feb 13 13:57:45 CET 2015
#Mon Jun 08 08:20:09 CEST 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
distributionUrl=https\://services.gradle.org/distributions/gradle-2.4-all.zip

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 44 KiB

BIN
images/asciidoc2_html.PNG Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 104 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 96 KiB

After

Width:  |  Height:  |  Size: 109 KiB

BIN
images/asciidoc_pdf.PNG Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 138 KiB

BIN
images/generated_docs.PNG Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 29 KiB

BIN
images/mkdocs_html.PNG Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

View File

@@ -0,0 +1,5 @@
This is a hand-written description.
AsciiDoc is better suited for descriptions than:
* JavaDoc
* Annotations

View File

@@ -0,0 +1 @@
This is a hand-written description. AsciiDoc is better suited for descriptions than *JavaDoc* and *Annotations*

View File

@@ -0,0 +1 @@
This is a hand-written description. AsciiDoc is better suited for descriptions than *JavaDoc* and *Annotations*

View File

@@ -0,0 +1,3 @@
include::{generated}/overview.adoc[]
include::{generated}/paths.adoc[]
include::{generated}/definitions.adoc[]

View File

@@ -0,0 +1,6 @@
[source,bash]
----
$ curl 'http://localhost:8080/api/pet/' -i -X POST -H 'Content-Type: application/json' -H 'Content-Length: 111' -d '{"id":1,"category":{"id":1,"name":"Hund"},"name":"Wuffy","photoUrls":[],"tags":[],"status":null,"identifier":1}'
----

View File

@@ -0,0 +1,10 @@
[source,http]
----
POST /api/pet/ HTTP/1.1
Content-Type: application/json
Content-Length: 111
{"id":1,"category":{"id":1,"name":"Hund"},"name":"Wuffy","photoUrls":[],"tags":[],"status":null,"identifier":1}
----

View File

@@ -0,0 +1,10 @@
[source,http]
----
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 7
SUCCESS
----

View File

@@ -0,0 +1,2 @@
This is a hand-written description.
AsciiDoc is better suited for descriptions than *JavaDoc* and *Annotations*

View File

@@ -0,0 +1,5 @@
This is a hand-written description.
AsciiDoc is better suited for descriptions than:
* JavaDoc
* Annotations

View File

@@ -1,534 +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
== Update an existing pet
----
PUT /pets
----
=== Parameters
[format="csv", options="header"]
|===
Name,Located in,Description,Required
body,body,Pet object that needs to be added to the store,false
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
400,Invalid ID supplied
404,Pet not found
405,Validation exception
|===
=== Consumes
* application/json
* application/xml
=== Produces
* application/json
* application/xml
== Add a new pet to the store
----
POST /pets
----
=== Parameters
[format="csv", options="header"]
|===
Name,Located in,Description,Required
body,body,Pet object that needs to be added to the store,false
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
405,Invalid input
|===
=== Consumes
* application/json
* application/xml
=== Produces
* application/json
* application/xml
== Finds Pets by status
----
GET /pets/findByStatus
----
=== Description
:hardbreaks:
Multiple status values can be provided with comma seperated strings
=== Parameters
[format="csv", options="header"]
|===
Name,Located in,Description,Required
status,query,Status values that need to be considered for filter,false
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
200,successful operation
400,Invalid status value
|===
=== Produces
* application/json
* application/xml
== 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
[format="csv", options="header"]
|===
Name,Located in,Description,Required
tags,query,Tags to filter by,false
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
200,successful operation
400,Invalid tag value
|===
=== Produces
* application/json
* application/xml
== 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
[format="csv", options="header"]
|===
Name,Located in,Description,Required
petId,path,ID of pet that needs to be fetched,true
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
200,successful operation
400,Invalid ID supplied
404,Pet not found
|===
=== Produces
* application/json
* application/xml
== Deletes a pet
----
DELETE /pets/{petId}
----
=== Parameters
[format="csv", options="header"]
|===
Name,Located in,Description,Required
api_key,header,,true
petId,path,Pet id to delete,true
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
400,Invalid pet value
|===
=== Produces
* application/json
* application/xml
== Updates a pet in the store with form data
----
POST /pets/{petId}
----
=== Parameters
[format="csv", options="header"]
|===
Name,Located in,Description,Required
petId,path,ID of pet that needs to be updated,true
name,formData,Updated name of the pet,true
status,formData,Updated status of the pet,true
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
405,Invalid input
|===
=== Consumes
* application/x-www-form-urlencoded
=== Produces
* application/json
* application/xml
== Place an order for a pet
----
POST /stores/order
----
=== Parameters
[format="csv", options="header"]
|===
Name,Located in,Description,Required
body,body,order placed for purchasing the pet,false
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
200,successful operation
400,Invalid Order
|===
=== Produces
* application/json
* application/xml
== 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
[format="csv", options="header"]
|===
Name,Located in,Description,Required
orderId,path,ID of pet that needs to be fetched,true
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
200,successful operation
400,Invalid ID supplied
404,Order not found
|===
=== Produces
* application/json
* application/xml
== 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
[format="csv", options="header"]
|===
Name,Located in,Description,Required
orderId,path,ID of the order that needs to be deleted,true
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
400,Invalid ID supplied
404,Order not found
|===
=== Produces
* application/json
* application/xml
== Create user
----
POST /users
----
=== Description
:hardbreaks:
This can only be done by the logged in user.
=== Parameters
[format="csv", options="header"]
|===
Name,Located in,Description,Required
body,body,Created user object,false
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
default,successful operation
|===
=== Produces
* application/json
* application/xml
== Creates list of users with given input array
----
POST /users/createWithArray
----
=== Parameters
[format="csv", options="header"]
|===
Name,Located in,Description,Required
body,body,List of user object,false
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
default,successful operation
|===
=== Produces
* application/json
* application/xml
== Creates list of users with given input array
----
POST /users/createWithList
----
=== Parameters
[format="csv", options="header"]
|===
Name,Located in,Description,Required
body,body,List of user object,false
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
default,successful operation
|===
=== Produces
* application/json
* application/xml
== Logs user into the system
----
GET /users/login
----
=== Parameters
[format="csv", options="header"]
|===
Name,Located in,Description,Required
username,query,The user name for login,false
password,query,The password for login in clear text,false
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
200,successful operation
400,Invalid username/password supplied
|===
=== Produces
* application/json
* application/xml
== Logs out current logged in user session
----
GET /users/logout
----
=== Responses
[format="csv", options="header"]
|===
Code,Description
default,successful operation
|===
=== Produces
* application/json
* application/xml
== Get user by user name
----
GET /users/{username}
----
=== Parameters
[format="csv", options="header"]
|===
Name,Located in,Description,Required
username,path,The name that needs to be fetched. Use user1 for testing.,true
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
200,successful operation
400,Invalid username supplied
404,User not found
|===
=== Produces
* application/json
* application/xml
== Updated user
----
PUT /users/{username}
----
=== Description
:hardbreaks:
This can only be done by the logged in user.
=== Parameters
[format="csv", options="header"]
|===
Name,Located in,Description,Required
username,path,name that need to be deleted,true
body,body,Updated user object,false
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
400,Invalid user supplied
404,User not found
|===
=== Produces
* application/json
* application/xml
== Delete user
----
DELETE /users/{username}
----
=== Description
:hardbreaks:
This can only be done by the logged in user.
=== Parameters
[format="csv", options="header"]
|===
Name,Located in,Description,Required
username,path,The name that needs to be deleted,true
|===
=== Responses
[format="csv", options="header"]
|===
Code,Description
400,Invalid username supplied
404,User not found
|===
=== Produces
* application/json
* application/xml
== Definitions
=== User
[format="csv", options="header"]
|===
Name,Type,Required
id,integer,false
username,string,false
firstName,string,false
lastName,string,false
email,string,false
password,string,false
phone,string,false
userStatus,integer,false
|===
=== Category
[format="csv", options="header"]
|===
Name,Type,Required
id,integer,false
name,string,false
|===
=== Pet
[format="csv", options="header"]
|===
Name,Type,Required
id,integer,false
category,ref,false
name,string,true
photoUrls,array,true
tags,array,false
status,string,false
|===
=== Tag
[format="csv", options="header"]
|===
Name,Type,Required
id,integer,false
name,string,false
|===
=== Order
[format="csv", options="header"]
|===
Name,Type,Required
id,integer,false
petId,integer,false
quantity,integer,false
shipDate,string,false
status,string,false
complete,boolean,false
|===

View File

@@ -0,0 +1,5 @@
This is a hand-written description.
AsciiDoc is better suited for descriptions than:
* JavaDoc
* Annotations

View File

@@ -0,0 +1 @@
This is a hand-written description. AsciiDoc is better suited for descriptions than *JavaDoc* and *Annotations*

View File

@@ -0,0 +1 @@
This is a hand-written description. AsciiDoc is better suited for descriptions than *JavaDoc* and *Annotations*

View File

@@ -0,0 +1 @@
This is a hand-written description. AsciiDoc is better suited for descriptions than *JavaDoc* and *Annotations*

View File

@@ -0,0 +1,5 @@
This is a hand-written description.
It is better suited for adding descriptions than:
* JavaDoc
* Annotations

View File

@@ -1,494 +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
## Update an existing pet
```
PUT /pets
```
### Parameters
|Name|Located in|Description|Required|
|----|----|----|----|
|body|body|Pet object that needs to be added to the store|false|
### Responses
|Code|Description|
|----|----|
|400|Invalid ID supplied|
|404|Pet not found|
|405|Validation exception|
### Consumes
* application/json
* application/xml
### Produces
* application/json
* application/xml
## Add a new pet to the store
```
POST /pets
```
### Parameters
|Name|Located in|Description|Required|
|----|----|----|----|
|body|body|Pet object that needs to be added to the store|false|
### Responses
|Code|Description|
|----|----|
|405|Invalid input|
### Consumes
* application/json
* application/xml
### Produces
* application/json
* application/xml
## Finds Pets by status
```
GET /pets/findByStatus
```
### Description
Multiple status values can be provided with comma seperated strings
### Parameters
|Name|Located in|Description|Required|
|----|----|----|----|
|status|query|Status values that need to be considered for filter|false|
### Responses
|Code|Description|
|----|----|
|200|successful operation|
|400|Invalid status value|
### Produces
* application/json
* application/xml
## Finds Pets by tags
```
GET /pets/findByTags
```
### Description
Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
### Parameters
|Name|Located in|Description|Required|
|----|----|----|----|
|tags|query|Tags to filter by|false|
### Responses
|Code|Description|
|----|----|
|200|successful operation|
|400|Invalid tag value|
### Produces
* application/json
* application/xml
## Find pet by ID
```
GET /pets/{petId}
```
### Description
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
### Parameters
|Name|Located in|Description|Required|
|----|----|----|----|
|petId|path|ID of pet that needs to be fetched|true|
### Responses
|Code|Description|
|----|----|
|200|successful operation|
|400|Invalid ID supplied|
|404|Pet not found|
### Produces
* application/json
* application/xml
## Deletes a pet
```
DELETE /pets/{petId}
```
### Parameters
|Name|Located in|Description|Required|
|----|----|----|----|
|api_key|header||true|
|petId|path|Pet id to delete|true|
### Responses
|Code|Description|
|----|----|
|400|Invalid pet value|
### Produces
* application/json
* application/xml
## Updates a pet in the store with form data
```
POST /pets/{petId}
```
### Parameters
|Name|Located in|Description|Required|
|----|----|----|----|
|petId|path|ID of pet that needs to be updated|true|
|name|formData|Updated name of the pet|true|
|status|formData|Updated status of the pet|true|
### Responses
|Code|Description|
|----|----|
|405|Invalid input|
### Consumes
* application/x-www-form-urlencoded
### Produces
* application/json
* application/xml
## Place an order for a pet
```
POST /stores/order
```
### Parameters
|Name|Located in|Description|Required|
|----|----|----|----|
|body|body|order placed for purchasing the pet|false|
### Responses
|Code|Description|
|----|----|
|200|successful operation|
|400|Invalid Order|
### Produces
* application/json
* application/xml
## 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
|Name|Located in|Description|Required|
|----|----|----|----|
|orderId|path|ID of pet that needs to be fetched|true|
### Responses
|Code|Description|
|----|----|
|200|successful operation|
|400|Invalid ID supplied|
|404|Order not found|
### Produces
* application/json
* application/xml
## 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
|Name|Located in|Description|Required|
|----|----|----|----|
|orderId|path|ID of the order that needs to be deleted|true|
### Responses
|Code|Description|
|----|----|
|400|Invalid ID supplied|
|404|Order not found|
### Produces
* application/json
* application/xml
## Create user
```
POST /users
```
### Description
This can only be done by the logged in user.
### Parameters
|Name|Located in|Description|Required|
|----|----|----|----|
|body|body|Created user object|false|
### Responses
|Code|Description|
|----|----|
|default|successful operation|
### Produces
* application/json
* application/xml
## Creates list of users with given input array
```
POST /users/createWithArray
```
### Parameters
|Name|Located in|Description|Required|
|----|----|----|----|
|body|body|List of user object|false|
### Responses
|Code|Description|
|----|----|
|default|successful operation|
### Produces
* application/json
* application/xml
## Creates list of users with given input array
```
POST /users/createWithList
```
### Parameters
|Name|Located in|Description|Required|
|----|----|----|----|
|body|body|List of user object|false|
### Responses
|Code|Description|
|----|----|
|default|successful operation|
### Produces
* application/json
* application/xml
## Logs user into the system
```
GET /users/login
```
### Parameters
|Name|Located in|Description|Required|
|----|----|----|----|
|username|query|The user name for login|false|
|password|query|The password for login in clear text|false|
### Responses
|Code|Description|
|----|----|
|200|successful operation|
|400|Invalid username/password supplied|
### Produces
* application/json
* application/xml
## Logs out current logged in user session
```
GET /users/logout
```
### Responses
|Code|Description|
|----|----|
|default|successful operation|
### Produces
* application/json
* application/xml
## Get user by user name
```
GET /users/{username}
```
### Parameters
|Name|Located in|Description|Required|
|----|----|----|----|
|username|path|The name that needs to be fetched. Use user1 for testing.|true|
### Responses
|Code|Description|
|----|----|
|200|successful operation|
|400|Invalid username supplied|
|404|User not found|
### Produces
* application/json
* application/xml
## Updated user
```
PUT /users/{username}
```
### Description
This can only be done by the logged in user.
### Parameters
|Name|Located in|Description|Required|
|----|----|----|----|
|username|path|name that need to be deleted|true|
|body|body|Updated user object|false|
### Responses
|Code|Description|
|----|----|
|400|Invalid user supplied|
|404|User not found|
### Produces
* application/json
* application/xml
## Delete user
```
DELETE /users/{username}
```
### Description
This can only be done by the logged in user.
### Parameters
|Name|Located in|Description|Required|
|----|----|----|----|
|username|path|The name that needs to be deleted|true|
### Responses
|Code|Description|
|----|----|
|400|Invalid username supplied|
|404|User not found|
### Produces
* application/json
* application/xml
## Definitions
### User
|Name|Type|Required|
|----|----|----|
|id|integer|false|
|username|string|false|
|firstName|string|false|
|lastName|string|false|
|email|string|false|
|password|string|false|
|phone|string|false|
|userStatus|integer|false|
### Category
|Name|Type|Required|
|----|----|----|
|id|integer|false|
|name|string|false|
### Pet
|Name|Type|Required|
|----|----|----|
|id|integer|false|
|category|ref|false|
|name|string|true|
|photoUrls|array|true|
|tags|array|false|
|status|string|false|
### Tag
|Name|Type|Required|
|----|----|----|
|id|integer|false|
|name|string|false|
### Order
|Name|Type|Required|
|----|----|----|
|id|integer|false|
|petId|integer|false|
|quantity|integer|false|
|shipDate|string|false|
|status|string|false|
|complete|boolean|false|

View File

@@ -0,0 +1,260 @@
/*
*
* Copyright 2015 Robert Winkler
*
* 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.
*
*
*/
package io.github.robwin.swagger2markup;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import io.github.robwin.markup.builder.MarkupLanguage;
import io.github.robwin.swagger2markup.builder.document.*;
import io.github.robwin.swagger2markup.utils.Consumer;
import io.swagger.models.Swagger;
import io.swagger.parser.SwaggerParser;
import io.swagger.util.Json;
import io.swagger.util.Yaml;
import org.apache.commons.lang3.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 final String descriptionsFolderPath;
private final boolean separatedDefinitions;
private static final String OVERVIEW_DOCUMENT = "overview";
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
* @param descriptionsFolderPath the folderPath where descriptions are stored
* @param separatedDefinitions create separate definition files for each model definition.
*/
Swagger2MarkupConverter(MarkupLanguage markupLanguage, Swagger swagger, String examplesFolderPath, String schemasFolderPath, String descriptionsFolderPath, boolean separatedDefinitions){
this.markupLanguage = markupLanguage;
this.swagger = swagger;
this.examplesFolderPath = examplesFolderPath;
this.schemasFolderPath = schemasFolderPath;
this.descriptionsFolderPath = descriptionsFolderPath;
this.separatedDefinitions = separatedDefinitions;
}
/**
* Creates a Swagger2MarkupConverter.Builder using a given Swagger source.
*
* @param swaggerLocation the Swagger location. Can be a HTTP url or a path to a local file.
* @return a Swagger2MarkupConverter
*/
public static Builder from(String swaggerLocation){
Validate.notEmpty(swaggerLocation, "swaggerLocation must not be empty!");
return new Builder(swaggerLocation);
}
/**
* 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);
}
/**
* Creates a Swagger2MarkupConverter.Builder from a given Swagger YAML or JSON String.
*
* @param swagger the Swagger YAML or JSON String.
* @return a Swagger2MarkupConverter
* @throws java.io.IOException if String can not be parsed
*/
public static Builder fromString(String swagger) throws IOException {
Validate.notEmpty(swagger, "swagger must not be null!");
ObjectMapper mapper;
if(swagger.trim().startsWith("{")) {
mapper = Json.mapper();
}else {
mapper = Yaml.mapper();
}
JsonNode rootNode = mapper.readTree(swagger);
// must have swagger node set
JsonNode swaggerNode = rootNode.get("swagger");
if(swaggerNode == null)
throw new IllegalArgumentException("Swagger String is in the wrong format");
return new Builder(mapper.convertValue(rootNode, Swagger.class));
}
/**
* 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
* @throws java.io.IOException if files can not be read
*/
public String asString() throws IOException{
return buildDocuments();
}
/**
* Builds all documents and writes them to a directory
* @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 OverviewDocument(swagger, markupLanguage).build().writeToFile(directory, OVERVIEW_DOCUMENT, StandardCharsets.UTF_8);
new PathsDocument(swagger, markupLanguage, examplesFolderPath, descriptionsFolderPath).build().writeToFile(directory, PATHS_DOCUMENT, StandardCharsets.UTF_8);
new DefinitionsDocument(swagger, markupLanguage, schemasFolderPath, descriptionsFolderPath, separatedDefinitions, directory).build().writeToFile(directory, DEFINITIONS_DOCUMENT, StandardCharsets.UTF_8);
}
/**
* Returns all documents as a String
* @return a the document as a String
*/
private String buildDocuments() throws IOException {
return new OverviewDocument(swagger, markupLanguage).build().toString()
.concat(new PathsDocument(swagger, markupLanguage, examplesFolderPath, schemasFolderPath).build().toString()
.concat(new DefinitionsDocument(swagger, markupLanguage, schemasFolderPath, schemasFolderPath, false, null).build().toString()));
}
public static class Builder{
private final Swagger swagger;
private String examplesFolderPath;
private String schemasFolderPath;
private String descriptionsFolderPath;
private boolean separatedDefinitions;
private MarkupLanguage markupLanguage = MarkupLanguage.ASCIIDOC;
/**
* Creates a Builder using a given Swagger source.
*
* @param swaggerLocation the Swagger location. Can be a HTTP url or a path to a local file.
*/
Builder(String swaggerLocation){
swagger = new SwaggerParser().read(swaggerLocation);
if(swagger == null){
throw new IllegalArgumentException("Failed to read the Swagger file. ");
}
}
/**
* 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, descriptionsFolderPath, separatedDefinitions);
}
/**
* 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 hand-written descriptions into the Paths and Definitions document
*
* @param descriptionsFolderPath the path to the folder where the description documents reside
* @return the Swagger2MarkupConverter.Builder
*/
public Builder withDescriptions(String descriptionsFolderPath){
this.descriptionsFolderPath = descriptionsFolderPath;
return this;
}
/**
* In addition to the definitions file, also create separate definition files for each model definition.
* @return the Swagger2MarkupConverter.Builder
*/
public Builder withSeparatedDefinitions() {
this.separatedDefinitions = true;
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;
}
/**
* Customize the Swagger data in any useful way
* @param preProcessor function object to mutate the swagger object
* @return the Swagger2MarkupConverter.Builder
*/
public Builder preProcessSwagger(Consumer<Swagger> preProcessor) {
preProcessor.accept(this.swagger);
return this;
}
}
}

View File

@@ -0,0 +1,310 @@
/*
*
* Copyright 2015 Robert Winkler
*
* 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.
*
*
*/
package io.github.robwin.swagger2markup.builder.document;
import com.google.common.collect.ImmutableMap;
import io.github.robwin.markup.builder.MarkupDocBuilder;
import io.github.robwin.markup.builder.MarkupDocBuilders;
import io.swagger.models.ComposedModel;
import io.swagger.models.Model;
import io.swagger.models.RefModel;
import io.swagger.models.Swagger;
import io.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.lang3.StringUtils;
import org.apache.commons.lang3.Validate;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.*;
/**
* @author Robert Winkler
*/
public class DefinitionsDocument extends MarkupDocument {
private static final String DEFINITIONS = "Definitions";
private static final List<String> IGNORED_DEFINITIONS = Collections.singletonList("Void");
private static final String JSON_SCHEMA = "JSON Schema";
private static final String XML_SCHEMA = "XML Schema";
private static final String JSON_SCHEMA_EXTENSION = ".json";
private static final String XML_SCHEMA_EXTENSION = ".xsd";
private static final String JSON = "json";
private static final String XML = "xml";
private static final String DESCRIPTION_FILE_NAME = "description";
private boolean schemasEnabled;
private String schemasFolderPath;
private boolean handWrittenDescriptionsEnabled;
private String descriptionsFolderPath;
private boolean separatedDefinitionsEnabled;
private String outputDirectory;
public DefinitionsDocument(Swagger swagger, MarkupLanguage markupLanguage, String schemasFolderPath, String descriptionsFolderPath, boolean separatedDefinitionsEnabled, String outputDirectory){
super(swagger, markupLanguage);
if(StringUtils.isNotBlank(schemasFolderPath)){
this.schemasEnabled = true;
this.schemasFolderPath = schemasFolderPath;
}
if(StringUtils.isNotBlank(descriptionsFolderPath)){
this.handWrittenDescriptionsEnabled = true;
this.descriptionsFolderPath = descriptionsFolderPath + "/" + DEFINITIONS.toLowerCase();
}
if(schemasEnabled){
if (logger.isDebugEnabled()) {
logger.debug("Include schemas is enabled.");
}
}else{
if (logger.isDebugEnabled()) {
logger.debug("Include schemas is disabled.");
}
}
if(handWrittenDescriptionsEnabled){
if (logger.isDebugEnabled()) {
logger.debug("Include hand-written descriptions is enabled.");
}
}else{
if (logger.isDebugEnabled()) {
logger.debug("Include hand-written descriptions is disabled.");
}
}
this.separatedDefinitionsEnabled = separatedDefinitionsEnabled;
if(this.separatedDefinitionsEnabled){
if (logger.isDebugEnabled()) {
logger.debug("Create separated definition files is enabled.");
}
Validate.notEmpty(outputDirectory, "Output directory is required for separated definition files!");
}else{
if (logger.isDebugEnabled()) {
logger.debug("Create separated definition files is disabled.");
}
}
this.outputDirectory = outputDirectory;
}
@Override
public MarkupDocument build() throws IOException {
definitions(swagger.getDefinitions(), this.markupDocBuilder);
return this;
}
/**
* Builds the Swagger definitions.
*
* @param definitions the Swagger definitions
* @param docBuilder the doc builder to use for output
*/
private void definitions(Map<String, Model> definitions, MarkupDocBuilder docBuilder) throws IOException {
if(MapUtils.isNotEmpty(definitions)){
docBuilder.sectionTitleLevel1(DEFINITIONS);
for(Map.Entry<String, Model> definitionsEntry : definitions.entrySet()){
String definitionName = definitionsEntry.getKey();
if(StringUtils.isNotBlank(definitionName)) {
if (checkThatDefinitionIsNotInIgnoreList(definitionName)) {
definition(definitions, definitionName, definitionsEntry.getValue(), docBuilder);
definitionSchema(definitionName, docBuilder);
if (separatedDefinitionsEnabled) {
MarkupDocBuilder defDocBuilder = MarkupDocBuilders.documentBuilder(markupLanguage);
definition(definitions, definitionName, definitionsEntry.getValue(), defDocBuilder);
definitionSchema(definitionName, defDocBuilder);
defDocBuilder.writeToFile(outputDirectory, definitionName.toLowerCase(), StandardCharsets.UTF_8);
if (logger.isInfoEnabled()) {
logger.info("Separate definition file produced: {}", 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
* @param docBuilder the docbuilder do use for output
*/
private void definition(Map<String, Model> definitions, String definitionName, Model model, MarkupDocBuilder docBuilder) throws IOException {
docBuilder.sectionTitleLevel2(definitionName);
descriptionSection(definitionName, model, docBuilder);
propertiesSection(definitions, definitionName, model, docBuilder);
}
private void propertiesSection(Map<String, Model> definitions, String definitionName, Model model, MarkupDocBuilder docBuilder) throws IOException {
Map<String, Property> properties = getAllProperties(definitions, model);
List<String> headerAndContent = new ArrayList<>();
List<String> header = Arrays.asList(NAME_COLUMN, DESCRIPTION_COLUMN, REQUIRED_COLUMN, SCHEMA_COLUMN, DEFAULT_COLUMN);
headerAndContent.add(StringUtils.join(header, DELIMITER));
if(MapUtils.isNotEmpty(properties)){
for (Map.Entry<String, Property> propertyEntry : properties.entrySet()) {
Property property = propertyEntry.getValue();
String propertyName = propertyEntry.getKey();
List<String> content = Arrays.asList(
propertyName,
propertyDescription(definitionName, propertyName, property),
Boolean.toString(property.getRequired()),
PropertyUtils.getType(property, markupLanguage),
PropertyUtils.getDefaultValue(property));
headerAndContent.add(StringUtils.join(content, DELIMITER));
}
docBuilder.tableWithHeaderRow(headerAndContent);
}
}
private Map<String, Property> getAllProperties(Map<String, Model> definitions, Model model) {
if(model instanceof RefModel) {
final String ref = model.getReference();
return definitions.containsKey(ref)
? getAllProperties(definitions, definitions.get(model.getReference()))
: null;
}
if(model instanceof ComposedModel) {
ComposedModel composedModel = (ComposedModel)model;
ImmutableMap.Builder<String, Property> allProperties = ImmutableMap.builder();
if(composedModel.getAllOf() != null) {
for(Model innerModel : composedModel.getAllOf()) {
Map<String, Property> innerProperties = getAllProperties(definitions, innerModel);
if(innerProperties != null) {
allProperties.putAll(innerProperties);
}
}
}
return allProperties.build();
}
else {
return model.getProperties();
}
}
private void descriptionSection(String definitionName, Model model, MarkupDocBuilder docBuilder) throws IOException {
if(handWrittenDescriptionsEnabled){
String description = handWrittenPathDescription(definitionName.toLowerCase(), DESCRIPTION_FILE_NAME);
if(StringUtils.isNotBlank(description)){
docBuilder.paragraph(description);
}else{
if (logger.isInfoEnabled()) {
logger.info("Hand-written description cannot be read. Trying to use description from Swagger source.");
}
modelDescription(model, docBuilder);
}
}
else{
modelDescription(model, docBuilder);
}
}
private void modelDescription(Model model, MarkupDocBuilder docBuilder) {
String description = model.getDescription();
if (StringUtils.isNotBlank(description)) {
docBuilder.paragraph(description);
}
}
private String propertyDescription(String definitionName, String propertyName, Property property) throws IOException {
String description;
if(handWrittenDescriptionsEnabled){
description = handWrittenPathDescription(definitionName.toLowerCase() + "/" + propertyName.toLowerCase(), DESCRIPTION_FILE_NAME);
if(StringUtils.isBlank(description)) {
if (logger.isInfoEnabled()) {
logger.info("Hand-written description file cannot be read. Trying to use description from Swagger source.");
}
description = StringUtils.defaultString(property.getDescription());
}
}
else{
description = StringUtils.defaultString(property.getDescription());
}
return description;
}
/**
* Reads a hand-written description
*
* @param descriptionFolder the name of the folder where the description file resides
* @param descriptionFileName the name of the description file
* @return the content of the file
* @throws IOException
*/
private String handWrittenPathDescription(String descriptionFolder, String descriptionFileName) throws IOException {
for (String fileNameExtension : markupLanguage.getFileNameExtensions()) {
java.nio.file.Path path = Paths.get(descriptionsFolderPath, descriptionFolder, descriptionFileName + fileNameExtension);
if (Files.isReadable(path)) {
if (logger.isInfoEnabled()) {
logger.info("Description file processed: {}", path);
}
return FileUtils.readFileToString(path.toFile(), StandardCharsets.UTF_8).trim();
} else {
if (logger.isDebugEnabled()) {
logger.debug("Description file is not readable: {}", path);
}
}
}
if (logger.isWarnEnabled()) {
logger.info("No description file found with correct file name extension in folder: {}", Paths.get(descriptionsFolderPath, descriptionFolder));
}
return null;
}
private void definitionSchema(String definitionName, MarkupDocBuilder docBuilder) throws IOException {
if(schemasEnabled) {
if (StringUtils.isNotBlank(definitionName)) {
schema(JSON_SCHEMA, schemasFolderPath, definitionName + JSON_SCHEMA_EXTENSION, JSON, docBuilder);
schema(XML_SCHEMA, schemasFolderPath, definitionName + XML_SCHEMA_EXTENSION, XML, docBuilder);
}
}
}
private void schema(String title, String schemasFolderPath, String schemaName, String language, MarkupDocBuilder docBuilder) throws IOException {
java.nio.file.Path path = Paths.get(schemasFolderPath, schemaName);
if (Files.isReadable(path)) {
docBuilder.sectionTitleLevel3(title);
docBuilder.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);
}
}
}
}

View File

@@ -0,0 +1,83 @@
/*
*
* Copyright 2015 Robert Winkler
*
* 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.
*
*
*/
package io.github.robwin.swagger2markup.builder.document;
import io.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 DEFAULT_COLUMN = "Default";
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 static final String PRODUCES = "Produces";
protected static final String CONSUMES = "Consumes";
protected static final String TAGS = "Tags";
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);
}
}

View File

@@ -0,0 +1,155 @@
/*
*
* Copyright 2015 Robert Winkler
*
* 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.
*
*
*/
package io.github.robwin.swagger2markup.builder.document;
import io.swagger.models.*;
import io.github.robwin.markup.builder.MarkupLanguage;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang3.StringUtils;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
public class OverviewDocument extends MarkupDocument {
private static final String OVERVIEW = "Overview";
private static final String CURRENT_VERSION = "Version information";
private static final String VERSION = "Version: ";
private static final String CONTACT_INFORMATION = "Contact information";
private static final String CONTACT_NAME = "Contact: ";
private static final String CONTACT_EMAIL = "Contact Email: ";
private static final String LICENSE_INFORMATION = "License information";
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 URI_SCHEME = "URI scheme";
private static final String HOST = "Host: ";
private static final String BASE_PATH = "BasePath: ";
private static final String SCHEMES = "Schemes: ";
public OverviewDocument(Swagger swagger, MarkupLanguage markupLanguage){
super(swagger, markupLanguage);
}
/**
* Builds the MarkupDocument.
*
* @return the built MarkupDocument
* @throws java.io.IOException if the files to include are not readable
*/
@Override
public MarkupDocument build() throws IOException {
overview();
return this;
}
/**
* Builds the document header of the swagger model
*/
private void overview() {
Info info = swagger.getInfo();
this.markupDocBuilder.documentTitle(info.getTitle());
this.markupDocBuilder.sectionTitleLevel1(OVERVIEW);
if(StringUtils.isNotBlank(info.getDescription())){
this.markupDocBuilder.textLine(info.getDescription());
this.markupDocBuilder.newLine();
}
if(StringUtils.isNotBlank(info.getVersion())){
this.markupDocBuilder.sectionTitleLevel2(CURRENT_VERSION);
this.markupDocBuilder.textLine(VERSION + info.getVersion());
this.markupDocBuilder.newLine();
}
Contact contact = info.getContact();
if(contact != null){
this.markupDocBuilder.sectionTitleLevel2(CONTACT_INFORMATION);
if(StringUtils.isNotBlank(contact.getName())){
this.markupDocBuilder.textLine(CONTACT_NAME + contact.getName());
}
if(StringUtils.isNotBlank(contact.getEmail())){
this.markupDocBuilder.textLine(CONTACT_EMAIL + contact.getEmail());
}
this.markupDocBuilder.newLine();
}
License license = info.getLicense();
if(license != null && (StringUtils.isNotBlank(license.getName()) || StringUtils.isNotBlank(license.getUrl()))) {
this.markupDocBuilder.sectionTitleLevel2(LICENSE_INFORMATION);
if (StringUtils.isNotBlank(license.getName())) {
this.markupDocBuilder.textLine(LICENSE + license.getName());
}
if (StringUtils.isNotBlank(license.getUrl())) {
this.markupDocBuilder.textLine(LICENSE_URL + license.getUrl());
}
this.markupDocBuilder.newLine();
}
if(StringUtils.isNotBlank(info.getTermsOfService())){
this.markupDocBuilder.textLine(TERMS_OF_SERVICE + info.getTermsOfService());
this.markupDocBuilder.newLine();
}
if(StringUtils.isNotBlank(swagger.getHost()) || StringUtils.isNotBlank(swagger.getBasePath()) || CollectionUtils.isNotEmpty(swagger.getSchemes())) {
this.markupDocBuilder.sectionTitleLevel2(URI_SCHEME);
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();
}
if(CollectionUtils.isNotEmpty(swagger.getTags())){
this.markupDocBuilder.sectionTitleLevel2(TAGS);
List<String> tags = new ArrayList<>();
for(Tag tag : swagger.getTags()){
String name = tag.getName();
String description = tag.getDescription();
if(StringUtils.isNoneBlank(description)){
tags.add(name + ": " + description);
}else{
tags.add(name);
}
}
this.markupDocBuilder.unorderedList(tags);
this.markupDocBuilder.newLine();
}
if(CollectionUtils.isNotEmpty(swagger.getConsumes())){
this.markupDocBuilder.sectionTitleLevel2(CONSUMES);
this.markupDocBuilder.unorderedList(swagger.getConsumes());
this.markupDocBuilder.newLine();
}
if(CollectionUtils.isNotEmpty(swagger.getProduces())){
this.markupDocBuilder.sectionTitleLevel2(PRODUCES);
this.markupDocBuilder.unorderedList(swagger.getProduces());
this.markupDocBuilder.newLine();
}
}
}

View File

@@ -0,0 +1,381 @@
/*
*
* Copyright 2015 Robert Winkler
*
* 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.
*
*
*/
package io.github.robwin.swagger2markup.builder.document;
import io.swagger.models.Operation;
import io.swagger.models.Path;
import io.swagger.models.Response;
import io.swagger.models.Swagger;
import io.swagger.models.parameters.Parameter;
import io.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.lang3.StringUtils;
import org.apache.commons.lang3.text.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 PARAMETERS = "Parameters";
private static final String RESPONSES = "Responses";
private static final String EXAMPLE_CURL = "Example CURL request";
private static final String EXAMPLE_REQUEST = "Example HTTP request";
private static final String EXAMPLE_RESPONSE = "Example HTTP 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 = "http-request";
private static final String RESPONSE_EXAMPLE_FILE_NAME = "http-response";
private static final String CURL_EXAMPLE_FILE_NAME = "curl-request";
private static final String DESCRIPTION_FILE_NAME = "description";
private static final String PARAMETER = "Parameter";
private boolean examplesEnabled;
private String examplesFolderPath;
private boolean handWrittenDescriptionsEnabled;
private String descriptionsFolderPath;
public PathsDocument(Swagger swagger, MarkupLanguage markupLanguage, String examplesFolderPath, String descriptionsFolderPath){
super(swagger, markupLanguage);
if(StringUtils.isNotBlank(examplesFolderPath)){
this.examplesEnabled = true;
this.examplesFolderPath = examplesFolderPath;
}
if(StringUtils.isNotBlank(descriptionsFolderPath)){
this.handWrittenDescriptionsEnabled = true;
this.descriptionsFolderPath = descriptionsFolderPath + "/" + PATHS.toLowerCase();
}
if(examplesEnabled){
if (logger.isDebugEnabled()) {
logger.debug("Include examples is enabled.");
}
}else{
if (logger.isDebugEnabled()) {
logger.debug("Include examples is disabled.");
}
}
if(handWrittenDescriptionsEnabled){
if (logger.isDebugEnabled()) {
logger.debug("Include hand-written descriptions is enabled.");
}
}else{
if (logger.isDebugEnabled()) {
logger.debug("Include hand-written descriptions is disabled.");
}
}
}
@Override
public MarkupDocument build() throws IOException {
paths();
return this;
}
/**
* 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();
if(path != null) {
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) throws IOException {
if(handWrittenDescriptionsEnabled){
String summary = operation.getSummary();
if(StringUtils.isNotBlank(summary)) {
String operationFolder = summary.replace(".", "").replace(" ", "_").toLowerCase();
String description = handWrittenPathDescription(operationFolder, DESCRIPTION_FILE_NAME);
if(StringUtils.isNotBlank(description)){
this.markupDocBuilder.sectionTitleLevel3(DESCRIPTION);
this.markupDocBuilder.paragraph(description);
}else{
if (logger.isInfoEnabled()) {
logger.info("Hand-written description cannot be read. Trying to use description from Swagger source.");
}
pathDescription(operation);
}
}else{
if (logger.isInfoEnabled()) {
logger.info("Hand-written description cannot be read, because summary of operation is empty. Trying to use description from Swagger source.");
}
pathDescription(operation);
}
}else {
pathDescription(operation);
}
}
private void pathDescription(Operation operation) {
String description = operation.getDescription();
if (StringUtils.isNotBlank(description)) {
this.markupDocBuilder.sectionTitleLevel3(DESCRIPTION);
this.markupDocBuilder.paragraph(description);
}
}
private void parametersSection(Operation operation) throws IOException {
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, DEFAULT_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(),
parameterDescription(operation, parameter),
Boolean.toString(parameter.getRequired()), type,
ParameterUtils.getDefaultValue(parameter));
headerAndContent.add(StringUtils.join(content, DELIMITER));
}
this.markupDocBuilder.sectionTitleLevel3(PARAMETERS);
this.markupDocBuilder.tableWithHeaderRow(headerAndContent);
}
}
private String parameterDescription(Operation operation, Parameter parameter) throws IOException {
String description;
if(handWrittenDescriptionsEnabled){
String summary = operation.getSummary();
String operationFolder = summary.replace(".", "").replace(" ", "_").toLowerCase();
String parameterName = parameter.getName();
if(StringUtils.isNotBlank(operationFolder) && StringUtils.isNotBlank(parameterName)) {
description = handWrittenPathDescription(operationFolder + "/" + parameterName, DESCRIPTION_FILE_NAME);
if(StringUtils.isBlank(description)) {
if (logger.isInfoEnabled()) {
logger.info("Hand-written description file cannot be read. Trying to use description from Swagger source.");
}
description = StringUtils.defaultString(parameter.getDescription());
}
}else{
if (logger.isInfoEnabled()) {
logger.info("Hand-written description file cannot be read, because summary of operation or name of parameter is empty. Trying to use description from Swagger source.");
}
description = StringUtils.defaultString(parameter.getDescription());
}
}else {
description = StringUtils.defaultString(parameter.getDescription());
}
return description;
}
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();
String curlExample = example(exampleFolder, CURL_EXAMPLE_FILE_NAME);
if(StringUtils.isNotBlank(curlExample)){
this.markupDocBuilder.sectionTitleLevel3(EXAMPLE_CURL);
this.markupDocBuilder.paragraph(curlExample);
}
String requestExample = example(exampleFolder, REQUEST_EXAMPLE_FILE_NAME);
if(StringUtils.isNotBlank(requestExample)){
this.markupDocBuilder.sectionTitleLevel3(EXAMPLE_REQUEST);
this.markupDocBuilder.paragraph(requestExample);
}
String responseExample = example(exampleFolder, RESPONSE_EXAMPLE_FILE_NAME);
if(StringUtils.isNotBlank(responseExample)){
this.markupDocBuilder.sectionTitleLevel3(EXAMPLE_RESPONSE);
this.markupDocBuilder.paragraph(responseExample);
}
}else{
if (logger.isWarnEnabled()) {
logger.warn("Example file cannot be read, because summary of operation is empty.");
}
}
}
}
/**
* Reads an example
*
* @param exampleFolder the name of the folder where the example file resides
* @param exampleFileName the name of the example file
* @return the content of the file
* @throws IOException
*/
private String example(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)) {
if (logger.isInfoEnabled()) {
logger.info("Example file processed: {}", path);
}
return FileUtils.readFileToString(path.toFile(), StandardCharsets.UTF_8).trim();
} else {
if (logger.isDebugEnabled()) {
logger.debug("Example file is not readable: {}", path);
}
}
}
if (logger.isWarnEnabled()) {
logger.info("No example file found with correct file name extension in folder: {}", Paths.get(examplesFolderPath, exampleFolder));
}
return null;
}
/**
* Reads a hand-written description
*
* @param descriptionFolder the name of the folder where the description file resides
* @param descriptionFileName the name of the description file
* @return the content of the file
* @throws IOException
*/
private String handWrittenPathDescription(String descriptionFolder, String descriptionFileName) throws IOException {
for (String fileNameExtension : markupLanguage.getFileNameExtensions()) {
java.nio.file.Path path = Paths.get(descriptionsFolderPath, descriptionFolder, descriptionFileName + fileNameExtension);
if (Files.isReadable(path)) {
if (logger.isInfoEnabled()) {
logger.info("Description file processed: {}", path);
}
return FileUtils.readFileToString(path.toFile(), StandardCharsets.UTF_8).trim();
} else {
if (logger.isDebugEnabled()) {
logger.debug("Description file is not readable: {}", path);
}
}
}
if (logger.isWarnEnabled()) {
logger.info("No description file found with correct file name extension in folder: {}", Paths.get(descriptionsFolderPath, descriptionFolder));
}
return null;
}
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);
}
}
}

View File

@@ -0,0 +1,14 @@
package io.github.robwin.swagger2markup.utils;
/**
* Java 8 style Consumer functional interface
*/
public interface Consumer<T> {
/**
* The function itself
* @param t the function argument
*/
void accept(T t);
}

View File

@@ -0,0 +1,45 @@
/*
*
* Copyright 2015 Robert Winkler
*
* 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.
*
*
*/
package io.github.robwin.swagger2markup.utils;
import io.swagger.models.ArrayModel;
import io.swagger.models.Model;
import io.swagger.models.ModelImpl;
import io.swagger.models.RefModel;
import io.github.robwin.markup.builder.MarkupLanguage;
import org.apache.commons.lang3.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";
}
}

View File

@@ -0,0 +1,92 @@
/*
*
* Copyright 2015 Robert Winkler
*
* 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.
*
*
*/
package io.github.robwin.swagger2markup.utils;
import io.swagger.models.Model;
import io.swagger.models.parameters.AbstractSerializableParameter;
import io.swagger.models.parameters.BodyParameter;
import io.swagger.models.parameters.Parameter;
import io.swagger.models.parameters.RefParameter;
import io.github.robwin.markup.builder.MarkupLanguage;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.Validate;
import java.util.List;
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();
if(model != null){
type = ModelUtils.getType(model, markupLanguage);
}else{
type = "string";
}
}
else if(parameter instanceof AbstractSerializableParameter){
AbstractSerializableParameter serializableParameter = (AbstractSerializableParameter)parameter;
List enums = serializableParameter.getEnum();
if(CollectionUtils.isNotEmpty(enums)){
type = "enum" + " (" + StringUtils.join(enums, ", ") + ")";
}else{
type = getTypeWithFormat(serializableParameter.getType(), serializableParameter.getFormat());
}
if(type.equals("array")){
String collectionFormat = serializableParameter.getCollectionFormat();
type = collectionFormat + " " + PropertyUtils.getType(serializableParameter.getItems(), markupLanguage) + " " + type;
}
}
else if(parameter instanceof RefParameter){
RefParameter refParameter = (RefParameter)parameter;
switch (markupLanguage){
case ASCIIDOC: return "<<" + refParameter.getSimpleRef() + ">>";
default: return refParameter.getSimpleRef();
}
}
return StringUtils.defaultString(type);
}
private static String getTypeWithFormat(String typeWithoutFormat, String format) {
String type;
if(StringUtils.isNotBlank(format)){
type = StringUtils.defaultString(typeWithoutFormat) + " (" + format + ")";
}else{
type = StringUtils.defaultString(typeWithoutFormat);
}
return type;
}
public static String getDefaultValue(Parameter parameter){
Validate.notNull(parameter, "property must not be null!");
String defaultValue = "";
if(parameter instanceof AbstractSerializableParameter){
AbstractSerializableParameter serializableParameter = (AbstractSerializableParameter)parameter;
defaultValue = serializableParameter.getDefaultValue();
}
return StringUtils.defaultString(defaultValue);
}
}

View File

@@ -0,0 +1,93 @@
/*
*
* Copyright 2015 Robert Winkler
*
* 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.
*
*
*/
package io.github.robwin.swagger2markup.utils;
import io.swagger.models.properties.*;
import io.github.robwin.markup.builder.MarkupLanguage;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.Validate;
import java.util.List;
import java.util.Objects;
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 = StringUtils.defaultString(property.getType()) + " (" + property.getFormat() + ")";
}else{
type = property.getType();
}
}
return StringUtils.defaultString(type);
}
public static String getDefaultValue(Property property){
Validate.notNull(property, "property must not be null!");
String defaultValue = "";
if(property instanceof BooleanProperty){
BooleanProperty booleanProperty = (BooleanProperty)property;
defaultValue = Objects.toString(booleanProperty.getDefault(), "");
}else if(property instanceof StringProperty){
StringProperty stringProperty = (StringProperty)property;
defaultValue = Objects.toString(stringProperty.getDefault(), "");
}else if(property instanceof DoubleProperty){
DoubleProperty doubleProperty = (DoubleProperty)property;
defaultValue = Objects.toString(doubleProperty.getDefault(), "");
}else if(property instanceof FloatProperty){
FloatProperty floatProperty = (FloatProperty)property;
defaultValue = Objects.toString(floatProperty.getDefault(), "");
}else if(property instanceof IntegerProperty){
IntegerProperty integerProperty = (IntegerProperty)property;
defaultValue = Objects.toString(integerProperty.getDefault(), "");
}
else if(property instanceof LongProperty){
LongProperty longProperty = (LongProperty)property;
defaultValue = Objects.toString(longProperty.getDefault(), "");
}
else if(property instanceof UUIDProperty){
UUIDProperty uuidProperty = (UUIDProperty)property;
defaultValue = Objects.toString(uuidProperty.getDefault(), "");
}
return defaultValue;
}
}

View File

@@ -1,203 +0,0 @@
package io.swagger2markup;
import com.wordnik.swagger.models.*;
import com.wordnik.swagger.models.parameters.Parameter;
import com.wordnik.swagger.models.properties.Property;
import io.swagger.parser.SwaggerParser;
import io.swagger2markup.builder.DocumentBuilder;
import io.swagger2markup.builder.asciidoc.AsciiDocBuilder;
import io.swagger2markup.builder.markdown.MarkdownBuilder;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.collections.MapUtils;
import org.apache.commons.lang.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.BufferedWriter;
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 Swagger2MarkupConverter {
private static final Logger logger = LoggerFactory.getLogger(Swagger2MarkupConverter.class);
private static final String VERSION = "Version: ";
private static final String SUMMARY = "Summary";
private static final String DESCRIPTION = "Description";
private static final String PARAMETERS = "Parameters";
private static final String PRODUCES = "Produces";
private static final String CONSUMES = "Consumes";
private static final String RESPONSES = "Responses";
private static final String DEFINITIONS = "Definitions";
private static final List<String> IGNORED_DEFINITIONS = Arrays.asList("Void");
private final Swagger swagger;
private DocumentBuilder documentBuilder;
private Swagger2MarkupConverter(String swaggerFileLocation){
swagger = new SwaggerParser().read(swaggerFileLocation);
}
public static Swagger2MarkupConverter from(String swaggerFileLocation){
return new Swagger2MarkupConverter(swaggerFileLocation);
}
public void toAsciiDoc(String fileLocation) throws IOException {
documentBuilder = new AsciiDocBuilder();
buildDocument();
writeAsciiDocFile(fileLocation);
}
public void toMarkdown(String fileLocation) throws IOException {
documentBuilder = new MarkdownBuilder();
buildDocument();
writeAsciiDocFile(fileLocation);
}
private void buildDocument(){
documentHeader(swagger.getInfo());
paths(swagger.getPaths());
definitions(swagger.getDefinitions());
}
private void writeAsciiDocFile(String asciiDocFileLocation) throws IOException {
try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(asciiDocFileLocation),
StandardCharsets.UTF_8)){
writer.write(documentBuilder.toString());
} catch (IOException e) {
logger.warn("Failed to convert Swagger file to AsciiDoc", e);
throw e;
}
}
private void paths(Map<String, Path> 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());
}
}
private void documentHeader(Info info) {
documentBuilder
.documentTitle(info.getTitle())
.textLine(info.getDescription())
.textLine(VERSION + info.getVersion())
.newLine();
}
private void path(String httpMethod, String resourcePath, Operation operation) {
if(operation != null){
pathTitle(httpMethod, resourcePath, operation);
descriptionSection(operation);
parametersSection(operation);
responsesSection(operation);
consumesSection(operation);
producesSection(operation);
}
}
private void pathTitle(String httpMethod, String resourcePath, Operation operation) {
String summary = operation.getSummary();
if(StringUtils.isNotBlank(summary)) {
documentBuilder.sectionTitleLevel1(operation.getSummary());
documentBuilder.listing(httpMethod + " " + resourcePath);
}else{
documentBuilder.sectionTitleLevel1(httpMethod + " " + resourcePath);
}
}
private void descriptionSection(Operation operation) {
String description = operation.getDescription();
if(StringUtils.isNotBlank(description)){
documentBuilder.sectionTitleLevel2(DESCRIPTION);
documentBuilder.paragraph(description);
}
}
private void consumesSection(Operation operation) {
List<String> consumes = operation.getConsumes();
if(CollectionUtils.isNotEmpty(consumes)){
documentBuilder.sectionTitleLevel2(CONSUMES);
documentBuilder.unorderedList(consumes);
}
}
private void producesSection(Operation operation) {
List<String> produces = operation.getProduces();
if(CollectionUtils.isNotEmpty(produces)){
documentBuilder.sectionTitleLevel2(PRODUCES);
documentBuilder.unorderedList(produces);
}
}
private void parametersSection(Operation operation) {
List<Parameter> parameters = operation.getParameters();
if(CollectionUtils.isNotEmpty(parameters)){
List<String> csvContent = new ArrayList<>();
csvContent.add("Name,Located in,Description,Required");
for(Parameter parameter : parameters){
StringBuilder rowBuilder = new StringBuilder();
rowBuilder.append(parameter.getName()).append(",").
append(parameter.getIn()).append(",").
append(parameter.getDescription()).append(",").
append(parameter.getRequired());
csvContent.add(rowBuilder.toString());
}
documentBuilder.sectionTitleLevel2(PARAMETERS);
documentBuilder.tableWithHeaderRow(csvContent);
}
}
private void responsesSection(Operation operation) {
Map<String, Response> responses = operation.getResponses();
if(MapUtils.isNotEmpty(responses)){
List<String> csvContent = new ArrayList<>();
csvContent.add("Code,Description");
for(Map.Entry<String, Response> entry : responses.entrySet()){
Response response = entry.getValue();
StringBuilder rowBuilder = new StringBuilder();
rowBuilder.append(entry.getKey()).append(",").
append(response.getDescription());
csvContent.add(rowBuilder.toString());
}
documentBuilder.sectionTitleLevel2(RESPONSES);
documentBuilder.tableWithHeaderRow(csvContent);
}
}
private void definitions(Map<String, Model> definitions) {
if(MapUtils.isNotEmpty(definitions)){
documentBuilder.sectionTitleLevel1(DEFINITIONS);
for(Map.Entry<String, Model> definitionsEntry : definitions.entrySet()){
String definitionName = definitionsEntry.getKey();
if(!IGNORED_DEFINITIONS.contains(definitionName)) {
documentBuilder.sectionTitleLevel2(definitionName);
Model model = definitionsEntry.getValue();
Map<String, Property> properties = model.getProperties();
List<String> csvContent = new ArrayList<>();
csvContent.add("Name,Type,Required");
for (Map.Entry<String, Property> propertyEntry : properties.entrySet()) {
Property property = propertyEntry.getValue();
StringBuilder rowBuilder = new StringBuilder();
rowBuilder.append(propertyEntry.getKey()).append(",").
append(property.getType()).append(",").append(property.getRequired());
csvContent.add(rowBuilder.toString());
}
documentBuilder.tableWithHeaderRow(csvContent);
}
}
}
}
}

View File

@@ -1,74 +0,0 @@
package io.swagger2markup.builder;
import java.util.List;
/**
* @author Robert Winkler
*/
public abstract class AbstractDocumentBuilder implements DocumentBuilder {
protected StringBuilder documentBuilder = new StringBuilder();
protected String newLine = System.getProperty("line.separator");
protected void documentTitle(Markup markup, String title){
documentBuilder.append(markup).append(title).append(newLine);
}
protected void sectionTitleLevel1(Markup markup, String title){
documentBuilder.append(markup).append(title).append(newLine);
}
protected void sectionTitleLevel2(Markup markup, String title){
documentBuilder.append(markup).append(title).append(newLine);
}
protected void sectionTitleLevel3(Markup markup, String title){
documentBuilder.append(markup).append(title).append(newLine);
}
public DocumentBuilder textLine(String text){
documentBuilder.append(text).append(newLine);
return this;
}
protected void paragraph(Markup markup, String text){
documentBuilder.append(markup).append(newLine).append(text).append(newLine).append(newLine);
}
protected void listing(Markup markup, String text){
delimitedTextLine(markup, text);
}
private void delimitedTextLine(Markup markup, String text){
documentBuilder.append(markup).append(newLine).append(text).append(newLine).append(markup).append(newLine).append(newLine);
}
protected void preserveLineBreaks(Markup markup){
documentBuilder.append(markup).append(newLine);
}
protected void boldTextLine(Markup markup, String text){
delimitedTextLine(markup, text);
}
protected void italicTextLine(Markup markup, String text){
delimitedTextLine(markup, text);
}
protected void unorderedList(Markup markup, List<String> list){
for(String listEntry : list){
documentBuilder.append(markup).append(listEntry).append(newLine);
}
documentBuilder.append(newLine);
}
public DocumentBuilder newLine(){
documentBuilder.append(newLine);
return this;
}
@Override
public String toString(){
return documentBuilder.toString();
}
}

View File

@@ -1,34 +0,0 @@
package io.swagger2markup.builder;
import java.util.List;
/**
* @author Robert Winkler
*/
public interface DocumentBuilder {
DocumentBuilder documentTitle(String title);
DocumentBuilder sectionTitleLevel1(String title);
DocumentBuilder sectionTitleLevel2(String title);
DocumentBuilder sectionTitleLevel3(String title);
DocumentBuilder textLine(String text);
DocumentBuilder paragraph(String text);
DocumentBuilder listing(String text);
DocumentBuilder boldTextLine(String text);
DocumentBuilder italicTextLine(String text);
DocumentBuilder unorderedList(List<String> list);
DocumentBuilder tableWithHeaderRow(List<String> rowsInCSV);
DocumentBuilder newLine();
String toString();
}

View File

@@ -1,12 +0,0 @@
package io.swagger2markup.builder;
/**
* Project: swagger2asciidoc
* Copyright: Deutsche Telekom AG
*
* @author Robert Winkler <robert.winkler@telekom.de>
* @since 2.0.0
*/
public interface Markup {
public String toString();
}

View File

@@ -1,37 +0,0 @@
package io.swagger2markup.builder.asciidoc;
import io.swagger2markup.builder.Markup;
/**
* @author Robert Winkler
*/
public enum AsciiDoc implements Markup {
LABELED(":: "),
TABLE("|==="),
LISTING("----"),
HARDBREAKS(":hardbreaks:"),
DOCUMENT_TITLE("= "),
SECTION_TITLE_LEVEL1("== "),
SECTION_TITLE_LEVEL2("=== "),
SECTION_TITLE_LEVEL3("==== "),
BOLD("*"),
ITALIC("*"),
LIST_ENTRY("* ");
private final String markup;
/**
* @param markup AsciiDoc markup
*/
private AsciiDoc(final String markup) {
this.markup = markup;
}
/* (non-Javadoc)
* @see java.lang.Enum#toString()
*/
@Override
public String toString() {
return markup;
}
}

View File

@@ -1,77 +0,0 @@
package io.swagger2markup.builder.asciidoc;
import io.swagger2markup.builder.AbstractDocumentBuilder;
import io.swagger2markup.builder.DocumentBuilder;
import java.util.List;
/**
* @author Robert Winkler
*/
public class AsciiDocBuilder extends AbstractDocumentBuilder{
@Override
public DocumentBuilder documentTitle(String title){
documentTitle(AsciiDoc.DOCUMENT_TITLE, title);
return this;
}
@Override
public DocumentBuilder sectionTitleLevel1(String title){
sectionTitleLevel1(AsciiDoc.SECTION_TITLE_LEVEL1, title);
return this;
}
@Override
public DocumentBuilder sectionTitleLevel2(String title){
sectionTitleLevel2(AsciiDoc.SECTION_TITLE_LEVEL2, title);
return this;
}
@Override
public DocumentBuilder sectionTitleLevel3(String title){
sectionTitleLevel3(AsciiDoc.SECTION_TITLE_LEVEL3, title);
return this;
}
@Override
public DocumentBuilder paragraph(String text){
paragraph(AsciiDoc.HARDBREAKS, text);
return this;
}
@Override
public DocumentBuilder listing(String text){
listing(AsciiDoc.LISTING, text);
return this;
}
@Override
public DocumentBuilder boldTextLine(String text){
boldTextLine(AsciiDoc.BOLD, text);
return this;
}
@Override
public DocumentBuilder italicTextLine(String text) {
italicTextLine(AsciiDoc.ITALIC, text);
return this;
}
@Override
public DocumentBuilder unorderedList(List<String> list){
unorderedList(AsciiDoc.LIST_ENTRY, list);
return this;
}
@Override
public DocumentBuilder tableWithHeaderRow(List<String> rowsInCSV){
documentBuilder.append("[format=\"csv\", options=\"header\"]").append(newLine);
documentBuilder.append(AsciiDoc.TABLE).append(newLine);
for(String row : rowsInCSV){
documentBuilder.append(row).append(newLine);
}
documentBuilder.append(AsciiDoc.TABLE).append(newLine).append(newLine);
return this;
}
}

View File

@@ -1,41 +0,0 @@
package io.swagger2markup.builder.markdown;
import io.swagger2markup.builder.Markup;
/**
* Project: swagger2asciidoc
* Copyright: Deutsche Telekom AG
*
* @author Robert Winkler <robert.winkler@telekom.de>
* @since 2.0.0
*/
public enum Markdown implements Markup {
HARDBREAKS(""),
TABLE_COLUMN("|"),
TABLE_ROW("-"),
LISTING("```"),
DOCUMENT_TITLE("# "),
SECTION_TITLE_LEVEL1("## "),
SECTION_TITLE_LEVEL2("### "),
SECTION_TITLE_LEVEL3("### "),
BOLD("**"),
ITALIC("*"),
LIST_ENTRY("* ");
private final String markup;
/**
* @param markup AsciiDoc markup
*/
private Markdown(final String markup) {
this.markup = markup;
}
/* (non-Javadoc)
* @see java.lang.Enum#toString()
*/
@Override
public String toString() {
return markup;
}
}

View File

@@ -1,104 +0,0 @@
package io.swagger2markup.builder.markdown;
import io.swagger2markup.builder.AbstractDocumentBuilder;
import io.swagger2markup.builder.DocumentBuilder;
import java.util.Arrays;
import java.util.List;
/**
* Project: swagger2asciidoc
* Copyright: Deutsche Telekom AG
*
* @author Robert Winkler <robert.winkler@telekom.de>
* @since 2.0.0
*/
public class MarkdownBuilder extends AbstractDocumentBuilder
{
@Override
public DocumentBuilder documentTitle(String title){
documentTitle(Markdown.DOCUMENT_TITLE, title);
return this;
}
@Override
public DocumentBuilder sectionTitleLevel1(String title){
sectionTitleLevel1(Markdown.SECTION_TITLE_LEVEL1, title);
return this;
}
@Override
public DocumentBuilder sectionTitleLevel2(String title){
sectionTitleLevel2(Markdown.SECTION_TITLE_LEVEL2, title);
return this;
}
@Override
public DocumentBuilder sectionTitleLevel3(String title){
sectionTitleLevel3(Markdown.SECTION_TITLE_LEVEL3, title);
return this;
}
@Override
public DocumentBuilder paragraph(String text){
paragraph(Markdown.HARDBREAKS, text);
return this;
}
@Override
public DocumentBuilder listing(String text){
listing(Markdown.LISTING, text);
return this;
}
@Override
public DocumentBuilder boldTextLine(String text){
boldTextLine(Markdown.BOLD, text);
return this;
}
@Override
public DocumentBuilder italicTextLine(String text) {
italicTextLine(Markdown.ITALIC, text);
return this;
}
@Override
public DocumentBuilder unorderedList(List<String> list){
unorderedList(Markdown.LIST_ENTRY, list);
return this;
}
@Override
public DocumentBuilder tableWithHeaderRow(List<String> rowsInCSV){
String headersInCSV = rowsInCSV.get(0);
List<String> contentRowsInCSV = rowsInCSV.subList(1, rowsInCSV.size());
List<String> headers = Arrays.asList(headersInCSV.split(","));
// Header
documentBuilder.append(Markdown.TABLE_COLUMN);
for(String header : headers){
documentBuilder.append(header).append(Markdown.TABLE_COLUMN);
}
newLine();
// Header/Content separator
documentBuilder.append(Markdown.TABLE_COLUMN);
for(String header : headers){
for(int i = 1; i<5; i++) {
documentBuilder.append(Markdown.TABLE_ROW);
}
documentBuilder.append(Markdown.TABLE_COLUMN);
}
newLine();
// Content
for(String contentRow : contentRowsInCSV){
documentBuilder.append(Markdown.TABLE_COLUMN);
List<String> columns = Arrays.asList(contentRow.split(","));
for(String columnText : columns){
documentBuilder.append(columnText).append(Markdown.TABLE_COLUMN);
}
newLine();
}
newLine().newLine();
return this;
}
}

View File

@@ -0,0 +1,316 @@
/*
*
* Copyright 2015 Robert Winkler
*
* 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.
*
*
*/
package io.github.robwin.swagger2markup;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import io.github.robwin.markup.builder.MarkupLanguage;
import org.apache.commons.io.FileUtils;
import org.junit.Test;
import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.List;
import java.util.Map;
import java.util.Set;
import static java.util.Arrays.asList;
import static org.assertj.core.api.Assertions.fail;
import static org.assertj.core.api.BDDAssertions.assertThat;
public class Swagger2MarkupConverterTest {
@Test
public void testSwagger2AsciiDocConversion() throws IOException {
//Given
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/swagger.json").getFile());
File outputDirectory = new File("build/docs/asciidoc/generated");
FileUtils.deleteQuietly(outputDirectory);
//When
Swagger2MarkupConverter.from(file.getAbsolutePath()).build()
.intoFolder(outputDirectory.getAbsolutePath());
//Then
String[] directories = outputDirectory.list();
assertThat(directories).hasSize(3).containsAll(asList("definitions.adoc", "overview.adoc", "paths.adoc"));
}
@Test
public void testOldSwaggerSpec2AsciiDocConversion() throws IOException {
//Given
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/swagger_12.json").getFile());
File outputDirectory = new File("build/docs/asciidoc/generated");
FileUtils.deleteQuietly(outputDirectory);
//When
Swagger2MarkupConverter.from(file.getAbsolutePath()).build()
.intoFolder(outputDirectory.getAbsolutePath());
//Then
String[] directories = outputDirectory.list();
assertThat(directories).hasSize(3).containsAll(asList("definitions.adoc", "overview.adoc", "paths.adoc"));
}
@Test
public void testSwagger2AsciiDocConversionWithDescriptionsAndExamples() throws IOException {
//Given
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/swagger.json").getFile());
File outputDirectory = new File("build/docs/asciidoc/generated");
FileUtils.deleteQuietly(outputDirectory);
//When
Swagger2MarkupConverter.from(file.getAbsolutePath()).withDescriptions("src/docs/asciidoc")
.withExamples("src/docs/asciidoc/paths").build()
.intoFolder(outputDirectory.getAbsolutePath());
//Then
String[] directories = outputDirectory.list();
assertThat(directories).hasSize(3).containsAll(asList("definitions.adoc", "overview.adoc", "paths.adoc"));
}
@Test
public void testSwagger2AsciiDocConversionDoesNotContainUriScheme() throws IOException {
//Given
File file = new File(Swagger2MarkupConverterTest.class.getResource("/yaml/swagger_should_not_contain_uri_scheme.yaml").getFile());
File outputDirectory = new File("build/docs/asciidoc/generated");
FileUtils.deleteQuietly(outputDirectory);
//When
Swagger2MarkupConverter.from(file.getAbsolutePath()).build()
.intoFolder(outputDirectory.getAbsolutePath());
//Then
String[] directories = outputDirectory.list();
assertThat(directories).hasSize(3).containsAll(asList("definitions.adoc", "overview.adoc", "paths.adoc"));
assertThat(new String(Files.readAllBytes(Paths.get(outputDirectory + File.separator + "overview.adoc"))))
.doesNotContain("=== URI scheme");
}
@Test
public void testSwagger2AsciiDocConversionContainsUriScheme() throws IOException {
//Given
File file = new File(Swagger2MarkupConverterTest.class.getResource("/yaml/swagger_should_contain_uri_scheme.yaml").getFile());
File outputDirectory = new File("build/docs/asciidoc/generated");
FileUtils.deleteQuietly(outputDirectory);
//When
Swagger2MarkupConverter.from(file.getAbsolutePath()).build()
.intoFolder(outputDirectory.getAbsolutePath());
//Then
String[] directories = outputDirectory.list();
assertThat(directories).hasSize(3).containsAll(asList("definitions.adoc", "overview.adoc", "paths.adoc"));
assertThat(new String(Files.readAllBytes(Paths.get(outputDirectory + File.separator + "overview.adoc"))))
.contains("=== URI scheme");
}
@Test
public void testSwagger2MarkdownConversion() throws IOException {
//Given
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/swagger.json").getFile());
File outputDirectory = new File("build/docs/markdown/generated");
FileUtils.deleteQuietly(outputDirectory);
//When
Swagger2MarkupConverter.from(file.getAbsolutePath()).
withMarkupLanguage(MarkupLanguage.MARKDOWN).build()
.intoFolder(outputDirectory.getAbsolutePath());
//Then
String[] directories = outputDirectory.list();
assertThat(directories).hasSize(3).containsAll(asList("definitions.md", "overview.md", "paths.md"));
}
@Test
public void testSwagger2MarkdownConversionWithDescriptions() throws IOException {
//Given
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/swagger.json").getFile());
File outputDirectory = new File("build/docs/markdown/generated");
FileUtils.deleteQuietly(outputDirectory);
//When
Swagger2MarkupConverter.from(file.getAbsolutePath()).withDescriptions("src/docs/markdown").
withMarkupLanguage(MarkupLanguage.MARKDOWN).build()
.intoFolder(outputDirectory.getAbsolutePath());
//Then
String[] directories = outputDirectory.list();
assertThat(directories).hasSize(3).containsAll(asList("definitions.md", "overview.md", "paths.md"));
}
@Test
public void testSwagger2AsciiDocConversionWithSeparatedDefinitions() throws IOException {
//Given
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/swagger.json").getFile());
File outputDirectory = new File("build/docs/asciidoc/generated");
FileUtils.deleteQuietly(outputDirectory);
//When
Swagger2MarkupConverter.from(file.getAbsolutePath()).withSeparatedDefinitions().build()
.intoFolder(outputDirectory.getAbsolutePath());
//Then
String[] directories = outputDirectory.list();
assertThat(directories).hasSize(9).containsAll(
asList("definitions.adoc", "overview.adoc", "paths.adoc", "identified.adoc",
"user.adoc", "category.adoc", "pet.adoc", "tag.adoc", "order.adoc"));
assertThat(new String(Files.readAllBytes(Paths.get(outputDirectory + File.separator + "definitions.adoc"))))
.contains(new String(Files.readAllBytes(Paths.get(outputDirectory + File.separator + "user.adoc"))));
}
@Test
public void testSwagger2MarkdownConversionWithSeparatedDefinitions() throws IOException {
//Given
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/swagger.json").getFile());
File outputDirectory = new File("build/docs/asciidoc/generated");
FileUtils.deleteQuietly(outputDirectory);
//When
Swagger2MarkupConverter.from(file.getAbsolutePath()).withSeparatedDefinitions().
withMarkupLanguage(MarkupLanguage.MARKDOWN).build()
.intoFolder(outputDirectory.getAbsolutePath());
//Then
String[] directories = outputDirectory.list();
assertThat(directories).hasSize(9).containsAll(
asList("definitions.md", "overview.md", "paths.md", "identified.md",
"user.md", "category.md", "pet.md", "tag.md", "order.md"));
assertThat(new String(Files.readAllBytes(Paths.get(outputDirectory + File.separator + "definitions.md"))))
.contains(new String(Files.readAllBytes(Paths.get(outputDirectory + File.separator + "user.md"))));
}
@Test
public void testSwagger2MarkdownConversionHandlesComposition() throws IOException {
//Given
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/swagger.json").getFile());
File outputDirectory = new File("build/docs/asciidoc/generated");
FileUtils.deleteQuietly(outputDirectory);
//When
Swagger2MarkupConverter.from(file.getAbsolutePath()).withSeparatedDefinitions().
withMarkupLanguage(MarkupLanguage.MARKDOWN).build()
.intoFolder(outputDirectory.getAbsolutePath());
// Then
String[] directories = outputDirectory.list();
assertThat(directories).hasSize(9).containsAll(
asList("definitions.md", "overview.md", "paths.md", "identified.md",
"user.md", "category.md", "pet.md", "tag.md", "order.md"));
verifyMarkdownContainsFieldsInTables(
outputDirectory + File.separator + "definitions.md",
ImmutableMap.<String, Set<String>>builder()
.put("Identified", ImmutableSet.of("id"))
.put("User", ImmutableSet.of("id", "username", "firstName",
"lastName", "email", "password", "phone", "userStatus"))
.build());
verifyMarkdownContainsFieldsInTables(
outputDirectory + File.separator + "user.md",
ImmutableMap.<String, Set<String>>builder()
.put("User", ImmutableSet.of("id", "username", "firstName",
"lastName", "email", "password", "phone", "userStatus"))
.build()
);
}
/**
* Given a markdown document to search, this checks to see if the specified tables
* have all of the expected fields listed.
*
* @param doc path of markdown document to inspect
* @param fieldsByTable map of table name (header) to field names expected
* to be found in that table.
* @throws IOException if the markdown document could not be read
*/
private static void verifyMarkdownContainsFieldsInTables(String doc, Map<String, Set<String>> fieldsByTable) throws IOException {
final List<String> lines = Files.readAllLines(Paths.get(doc), Charset.defaultCharset());
final Map<String, Set<String>> fieldsLeftByTable = Maps.newHashMap();
for(Map.Entry<String, Set<String>> entry : fieldsByTable.entrySet()) {
fieldsLeftByTable.put(entry.getKey(), Sets.newHashSet(entry.getValue()));
}
String inTable = null;
for(String line : lines) {
// If we've found every field we care about, quit early
if(fieldsLeftByTable.isEmpty()) {
return;
}
// Transition to a new table if we encounter a header
final String currentHeader = getTableHeader(line);
if(inTable == null || currentHeader != null) {
inTable = currentHeader;
}
// If we're in a table that we care about, inspect this potential table row
if (inTable != null && fieldsLeftByTable.containsKey(inTable)){
// If we're still in a table, read the row and check for the field name
// NOTE: If there was at least one pipe, then there's at least 2 fields
String[] parts = line.split("\\|");
if(parts.length > 1) {
final String fieldName = parts[1];
final Set<String> fieldsLeft = fieldsLeftByTable.get(inTable);
// Mark the field as found and if this table has no more fields to find,
// remove it from the "fieldsLeftByTable" map to mark the table as done
if(fieldsLeft.remove(fieldName) && fieldsLeft.isEmpty()) {
fieldsLeftByTable.remove(inTable);
}
}
}
}
// After reading the file, if there were still types, fail
if(!fieldsLeftByTable.isEmpty()) {
fail(String.format("Markdown file '%s' did not contain expected fields (by table): %s",
doc, fieldsLeftByTable));
}
}
private static String getTableHeader(String line) {
return line.startsWith("###")
? line.replace("###", "").trim()
: null;
}
/*
@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 = "build/docs/generated/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);
}
}
*/
}

View File

@@ -1,20 +0,0 @@
package io.swagger2markup;
import org.junit.Test;
import java.io.File;
import java.io.IOException;
/**
* @author Robert Winkler
*/
public class Swagger2MarkupConverterTest {
@Test
public void testSwagger2AsciiDocConverter() throws IOException {
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/swagger.json").getFile());
Swagger2MarkupConverter.from(file.getAbsolutePath()).toAsciiDoc("src/docs/asciidoc/swagger.adoc");
Swagger2MarkupConverter.from(file.getAbsolutePath()).toMarkdown("src/docs/markdown/swagger.md");
}
}

View File

@@ -3,7 +3,7 @@
"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",
"title": "Swagger Petstore API",
"termsOfService": "http://helloreverb.com/terms/",
"contact": {
"name": "apiteam@wordnik.com"
@@ -134,13 +134,7 @@
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Pet"
}
}
"$ref": "#/responses/FoundPets"
},
"400": {
"description": "Invalid status value"
@@ -183,13 +177,7 @@
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Pet"
}
}
"$ref": "#/responses/FoundPets"
},
"400": {
"description": "Invalid tag value"
@@ -219,12 +207,7 @@
],
"parameters": [
{
"in": "path",
"name": "petId",
"description": "ID of pet that needs to be fetched",
"required": true,
"type": "integer",
"format": "int64"
"$ref": "#/parameters/petId"
}
],
"responses": {
@@ -563,14 +546,16 @@
"name": "username",
"description": "The user name for login",
"required": false,
"type": "string"
"type": "string",
"default": "testUser"
},
{
"in": "query",
"name": "password",
"description": "The password for login in clear text",
"required": false,
"type": "string"
"type": "string",
"default": "testPassword"
}
],
"responses": {
@@ -623,7 +608,8 @@
"name": "username",
"description": "The name that needs to be fetched. Use user1 for testing.",
"required": true,
"type": "string"
"type": "string",
"default": "testUser"
}
],
"responses": {
@@ -726,38 +712,77 @@
}
}
},
"responses":{
"FoundPets": {
"description": "successful operation",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Pet"
}
}
}
},
"parameters":{
"petId": {
"in": "path",
"name": "petId",
"description": "ID of the pet",
"required": true,
"type": "integer",
"format": "int64"
}
},
"definitions": {
"User": {
"Identified": {
"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"
}
}
},
"User": {
"allOf": [
{
"$ref": "#/definitions/Identified"
},
{
"properties": {
"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"
},
"pictures": {
"type": "array",
"items": {
"type": "string",
"format": "byte"
}
}
}
}
]
},
"Category": {
"properties": {
"id": {
@@ -770,6 +795,7 @@
}
},
"Pet": {
"description" : "Test description",
"required": [
"name",
"photoUrls"

View File

@@ -0,0 +1,54 @@
{
"apiVersion" : "0.0.1-SNAPSHOT",
"swaggerVersion" : "1.2",
"basePath" : "",
"resourcePath" : "/resource/x/v2",
"apis" : [ {
"path" : "/resource/x/v2",
"operations" : [ {
"method" : "POST",
"nickname" : "createX",
"type" : "string",
"parameters" : [ {
"type": "string",
"description" : "The x in JSON format",
"paramType" : "body",
"name" : "body",
"required" : true
} ],
"summary" : "Creates a x x.",
"notes" : "If id already exists, the x is updated.",
"responseMessages" : [ {
"code" : 200,
"message" : "ok"
}, {
"code" : 500,
"message" : "error"
} ],
"consumes" : [ "application/json" ]
} ]
}, {
"path" : "/resource/x/v2/{id}",
"operations" : [ {
"method" : "GET",
"nickname" : "getX",
"type" : "string",
"parameters" : [ {
"type" : "integer",
"description" : "A valid x x UUID",
"paramType" : "path",
"name" : "id",
"required" : true
} ],
"summary" : "Gets the x x with the specified id.",
"responseMessages" : [ {
"code" : 200,
"message" : "ok"
}, {
"code" : 404,
"message" : "not found"
} ],
"produces" : [ "application/json" ]
} ]
} ]
}

View File

@@ -0,0 +1,21 @@
swagger: '2.0'
info:
version: "0.0.0"
title: Test - Should contain URI scheme
host: localhost
schemes:
- http
- https
basePath: /api
paths:
/test:
get:
responses:
200:
description: OK
schema:
type: string

View File

@@ -0,0 +1,13 @@
swagger: '2.0'
info:
version: "0.0.0"
title: Test - Should not contain URI scheme
paths:
/test:
get:
responses:
200:
description: OK
schema:
type: string