Compare commits

..

40 Commits

Author SHA1 Message Date
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
35 changed files with 4872 additions and 657 deletions

View File

@@ -1,19 +1,24 @@
= Swagger2Markup
:author: Robert Winkler
:version: 0.1.0
:version: 0.2.3
:hardbreaks:
image:https://travis-ci.org/RobWin/swagger2markup.svg["Build Status", link="https://travis-ci.org/RobWin/swagger2markup"] image:https://coveralls.io/repos/RobWin/swagger2markup/badge.svg["Coverage Status", link="https://coveralls.io/r/RobWin/swagger2markup"] image:http://img.shields.io/:version-{version}-blue.svg["Semantic Versioning", link="https://bintray.com/robwin/maven/swagger2markup/0.1.0/view"] 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/RobWin/swagger2markup.svg["Build Status", link="https://travis-ci.org/RobWin/swagger2markup"] image:https://coveralls.io/repos/RobWin/swagger2markup/badge.svg["Coverage Status", link="https://coveralls.io/r/RobWin/swagger2markup"] image:https://api.bintray.com/packages/robwin/maven/swagger2markup/images/download.svg[link="https://bintray.com/robwin/maven/swagger2markup/_latestVersion"] image:http://img.shields.io/badge/license-ASF2-blue.svg["Apache License 2", link="http://www.apache.org/licenses/LICENSE-2.0.txt"]
image:https://badges.gitter.im/Join%20Chat.svg[link="https://gitter.im/RobWin/swagger2markup?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"]
== Overview
This project is a Swagger to Markup (AsciiDoc and Markdown) converter. The *Swagger2MarkupConverter* takes a swagger.json or swagger.yaml file as source and converts it into an AsciiDoc or Markdown document. The Swagger source file can be located locally or remotely accessible via HTTP. The Swagger2MarkupConverter supports the Swagger 1.2 and 2.0 specification. Internally it uses the _official_ https://github.com/swagger-api/swagger-parser[swagger-parser].
This project is a Swagger to Markup (AsciiDoc and Markdown) converter. The *Swagger2MarkupConverter* takes a swagger.json or swagger.yaml file as source and converts it into an AsciiDoc or Markdown document. The Swagger source file can be located locally or remotely accessible via HTTP. The Swagger2MarkupConverter supports the Swagger 1.2 and 2.0 specification. Internally it uses the _official_ https://github.com/swagger-api/swagger-parser[swagger-parser] and my https://github.com/RobWin/markup-document-builder[markup-document-builder].
The primary goal of this project is to simplify the documentation of RESTful APIs. The result is intended to be an easy-to-read, on- and offline user guide, comparable to https://developer.github.com/v3/[GitHub's API documentation].
Swagger2Markup can be used together with https://github.com/springfox/springfox[springfox] and https://github.com/spring-projects/spring-restdocs[spring-restdocs]. See <<integration-with-spring-restdocs, Integration with spring-restdocs>>.
The project requires at least JDK 7.
== Usage
=== Adding Swagger2Markup to your project
The project is published in JCenter and Maven Central.
==== Maven
@@ -21,16 +26,19 @@ The primary goal of this project is to simplify the documentation of RESTful API
----
<repositories>
<repository>
<id>jcenter-release</id>
<name>jcenter</name>
<url>http://oss.jfrog.org/artifactory/oss-release-local/</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
<id>central</id>
<name>bintray</name>
<url>http://jcenter.bintray.com</url>
</repository>
</repositories>
<dependency>
<groupId>io.github.robwin.swagger2markup</groupId>
<groupId>io.github.robwin</groupId>
<artifactId>swagger2markup</artifactId>
<version>0.2.0</version>
<version>0.2.3</version>
</dependency>
----
@@ -42,12 +50,12 @@ repositories {
jcenter()
}
compile "io.github.robwin:swagger2markup:0.2.0"
compile "io.github.robwin:swagger2markup:0.2.3"
----
=== Using Swagger2Markup
Using the Swagger2MarkupConverter is simple. For instance, you can generate your AsciiDoc/Markdown documentation using https://github.com/spring-projects/spring-boot[Spring Boot] and https://github.com/martypitt/swagger-springmvc[swagger-springmvc] as follows.
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/springfox/springfox[springfox] as follows.
See demo project https://github.com/RobWin/spring-swagger2markup-demo[spring-swagger2markup-demo].
[source,java]
@@ -60,21 +68,39 @@ public class Swagger2MarkupTest {
@Test
public void convertSwaggerToMarkup() {
//Remote
//Remote Swagger source
//Markdown
Swagger2MarkupConverter.from("http://localhost:8080/api-docs").
withMarkupLanguage(MarkupLanguage.MARKDOWN).
withExamples("docs/generated").withSchemas("docs/schemas").build()
withMarkupLanguage(MarkupLanguage.MARKDOWN).build()
.intoFolder("src/docs/markdown");
Swagger2MarkupConverter.from("http://localhost:8080/api-docs").
withExamples("docs").withSchemas("docs/schemas").build()
//Remote Swagger source
//Default is AsciiDoc
Swagger2MarkupConverter.from("http://localhost:8080/api-docs").build()
.intoFolder("src/docs/asciidoc");
//Local
//Local Swagger source
//Default is AsciiDoc
File file = new File(Swagger2MarkupTest.class.getResource("/json/swagger.json").getFile());
Swagger2MarkupConverter.from(file.getAbsolutePath()).build()
.intoFolder("src/docs/asciidoc");
}
@Test
public void testSwagger2HtmlConversion() throws IOException {
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/swagger.json").getFile());
String asciiDoc = Swagger2MarkupConverter.from(file.getAbsolutePath()).build().asString();
String path = "src/docs/asciidocAsString";
Files.createDirectories(Paths.get(path));
try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(path, "swagger.adoc"), StandardCharsets.UTF_8)){
writer.write(asciiDoc); }
String asciiDocAsHtml = Asciidoctor.Factory.create().convert(asciiDoc,
OptionsBuilder.options().backend("html5").headerFooter(true).safe(SafeMode.UNSAFE).docType("book").attributes(AttributesBuilder.attributes()
.tableOfContents(true).tableOfContents(Placement.LEFT).sectionNumbers(true).hardbreaks(true).setAnchors(true).attribute("sectlinks")));
try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(path, "swagger.html"), StandardCharsets.UTF_8)){
writer.write(asciiDocAsHtml);
}
}
}
----
@@ -134,13 +160,71 @@ image::images/mkdocs_html.PNG[mkdocs_html]
=== Generated PDF using AsciidoctorJ
image::images/asciidoc_pdf.PNG[asciidoc_pdf]
== Document Builder
The Swagger2Markup library allows to build an AsciiDoc or Markdown document via the Builder pattern:
== Integration with spring-restdocs
https://github.com/spring-projects/spring-restdocs[spring-restdocs] can be used together with Swagger2Markup.
Swagger2Markup can include the generated examples from spring-restdocs into the generated AsciiDoc document.
Currently it does not work for Markdown, since spring-restdocs generates only AsciiDoc files.
Let's say I have a Swagger-annotated Spring RestController method with an ApiOperation value: _"Create a quota"_
[source,java]
----
DocumentBuilder builder = DocumentBuilders.documentBuilder(MarkupLanguage.ASCIIDOC);
builder.documentTitle("Test title").textLine("Text line").writeToFile("/tmp", "test.adoc", StandardCharsets.UTF_8);
DocumentBuilder builder = DocumentBuilders.documentBuilder(MarkupLanguage.MARKDOWN);
builder.documentTitle("Test title").textLine("Text line").writeToFile("/tmp", "test.adoc", StandardCharsets.UTF_8);
@ApiOperation(value = "Create a quota", notes = "Create a quota allows bla bla bla bla")
public void createMailStorageQuota(@ApiParam(name = "MailStorageQuota",
value = "MailStorageQuota", required = true) @RequestBody MailStorageQuota mailStorageQuota) {
}
----
I'm using spring-restdocs in combination with https://github.com/jayway/rest-assured to test the Controller.
The target folder of the generated request and response example files must be _"create_a_quota"_ (similar to the value of the ApiOperation).
[source,java]
----
given().contentType(ContentType.XML).body(storageQuota).resultHandlers(document("create_a_quota")).
when().put("/quotas").
then().statusCode(204);
----
The spring-restdocs output directory is configured as follows:
[source]
----
io.restdocumented.outputDir = docs/generated
----
The Swagger2MarkupConverter must know the output directory of spring-restdocs.
[source,java]
----
Swagger2MarkupConverter.from("http://localhost:8080/api-docs").
withExamples("docs/generated").build()
.intoFolder("src/docs/asciidoc");
----
The Swagger2MarkupConverter searches for a Swagger ApiOperation with value: _"Create a quota"_ in a folder called _"docs/generated/create_a_quota"_ and includes the _request.asciidoc_ and _response.asciidoc_ files, if they are available.
== Integration of JSON and XML Schema files.
Swagger2Markup can also include JSON and XML Schema files into the generated document.
[source,java]
----
Swagger2MarkupConverter.from("http://localhost:8080/api-docs").
withMarkupLanguage(MarkupLanguage.MARKDOWN).
withExamples("docs/generated").withSchemas("docs/schemas").build()
.intoFolder("src/docs/markdown");
----
I create the Schemas files in Unit-Tests as follows:
[source,java]
----
RestDocumented restDocumented = RestDocumented.fromProperties();
restDocumented.documentJsonSchema(MailStorageQuota.class, "docs/schemas");
restDocumented.documentXmlSchema(MailStorageQuota.class, "docs/schemas");
----
I will make RestDocumented public soon. RestDocumented creates a MailStorageQuota.xsd and MailStorageQuota.json file in the folder "docs/schemas".
The Swagger2MarkupConverter will include the JSON and XML Schemas, if a Swagger Operation uses the MailStorageQuota class as Input or Output.
See example: http://spring-swagger2markup-demo.readthedocs.org/en/latest/generated/definitions/[ReadTheDocs-demo]

View File

@@ -4,4 +4,17 @@
* 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.
* 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

View File

@@ -6,14 +6,14 @@ 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 'io.spring.gradle:dependency-management-plugin:0.4.0.RELEASE'
classpath 'org.kt3k.gradle.plugin:coveralls-gradle-plugin:2.0.1'
classpath 'org.asciidoctor:asciidoctorj:1.5.2'
classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.0'
}
}
description = 'swagger2markup Build'
version = '0.2.0'
version = '0.2.4'
group = 'io.github.robwin'
apply plugin: 'java'
@@ -36,18 +36,23 @@ tasks.withType(JavaCompile) {
repositories {
jcenter()
mavenCentral()
mavenLocal()
}
dependencies {
compile 'io.github.robwin:markup-document-builder'
compile 'io.swagger:swagger-compat-spec-parser'
compile 'commons-collections:commons-collections'
compile 'commons-io:commons-io'
compile 'ch.qos.logback:logback-classic'
testCompile 'junit:junit'
testCompile 'org.asciidoctor:asciidoctorj:1.5.2'
testCompile 'org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.6'
}
dependencyManagement {
dependencies {
"io.github.robwin:markup-document-builder" "0.1.2"
"io.swagger:swagger-compat-spec-parser" "1.0.0"
"commons-collections:commons-collections" "3.2.1"
"commons-io:commons-io" "2.4"
@@ -58,13 +63,33 @@ dependencyManagement {
}
}
task sourcesJar(type: Jar, dependsOn: classes) {
classifier = 'sources'
from sourceSets.main.allSource
}
task javadocJar(type: Jar, dependsOn: javadoc) {
classifier = 'javadoc'
from javadoc.destinationDir
}
artifacts {
archives sourcesJar
archives javadocJar
}
asciidoctor {
sources {
include 'index.adoc'
}
backends = ['html5', 'pdf']
attributes = [
doctype: 'book',
toc: 'left',
toclevels: '2',
numbered: ''
numbered: '',
sectlinks: '',
sectanchors: ''
]
}
@@ -85,4 +110,4 @@ tasks.asciidoctor {
task wrapper(type: Wrapper) {
gradleVersion = '2.2.1'
}
}

View File

@@ -25,10 +25,15 @@ 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
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'
@@ -40,6 +45,15 @@ bintray {
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
}
}
}
}
@@ -51,6 +65,15 @@ publishing {
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')
@@ -70,6 +93,8 @@ publishing {
d.appendNode('name', it.value)
}
}
artifact sourcesJar
artifact javadocJar
}
}
}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 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: 105 KiB

After

Width:  |  Height:  |  Size: 95 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 153 KiB

After

Width:  |  Height:  |  Size: 124 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 29 KiB

View File

@@ -0,0 +1,55 @@
== Definitions
=== User
[options="header"]
|===
|Name|Description|Schema|Required
|id||integer (int64)|false
|username||string|false
|firstName||string|false
|lastName||string|false
|email||string|false
|password||string|false
|phone||string|false
|userStatus|User Status|integer (int32)|false
|===
=== Category
[options="header"]
|===
|Name|Description|Schema|Required
|id||integer (int64)|false
|name||string|false
|===
=== Pet
[options="header"]
|===
|Name|Description|Schema|Required
|id||integer (int64)|false
|category||<<Category>>|false
|name||string|true
|photoUrls||string array|true
|tags||<<Tag>> array|false
|status|pet status in the store|string|false
|===
=== Tag
[options="header"]
|===
|Name|Description|Schema|Required
|id||integer (int64)|false
|name||string|false
|===
=== Order
[options="header"]
|===
|Name|Description|Schema|Required
|id||integer (int64)|false
|petId||integer (int64)|false
|quantity||integer (int32)|false
|shipDate||string (date-time)|false
|status|Order Status|string|false
|complete||boolean|false
|===

View File

@@ -0,0 +1,9 @@
:doctype: book
:toc: left
:toclevels: 2
:numbered:
:sectlinks:
:sectanchors:
include::paths.adoc[]
include::definitions.adoc[]

View File

@@ -0,0 +1,582 @@
= Swagger Petstore
This is a sample server Petstore server.
[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.
For this sample, you can use the api key `special-key` to test the authorization filters
Version: 1.0.0
Contact: apiteam@wordnik.com
License: Apache 2.0
License URL: http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service: http://helloreverb.com/terms/
Host: petstore.swagger.wordnik.com
BasePath: /v2
Schemes: HTTP
== Paths
=== Update an existing pet
----
PUT /pets
----
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|BodyParameter|body|Pet object that needs to be added to the store|false|<<Pet>>
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content
|404|Pet not found|No Content
|405|Validation exception|No Content
|===
==== Consumes
* application/json
* application/xml
==== Produces
* application/json
* application/xml
==== Tags
* pet
=== Add a new pet to the store
----
POST /pets
----
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|BodyParameter|body|Pet object that needs to be added to the store|false|<<Pet>>
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|405|Invalid input|No Content
|===
==== Consumes
* application/json
* application/xml
==== Produces
* application/json
* application/xml
==== Tags
* pet
=== Finds Pets by status
----
GET /pets/findByStatus
----
==== Description
:hardbreaks:
Multiple status values can be provided with comma seperated strings
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|QueryParameter|status|Status values that need to be considered for filter|false|multi string array
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|200|successful operation|<<Pet>> array
|400|Invalid status value|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* pet
=== Finds Pets by tags
----
GET /pets/findByTags
----
==== Description
:hardbreaks:
Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|QueryParameter|tags|Tags to filter by|false|multi string array
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|200|successful operation|<<Pet>> array
|400|Invalid tag value|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* pet
=== Find pet by ID
----
GET /pets/{petId}
----
==== Description
:hardbreaks:
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|PathParameter|petId|ID of pet that needs to be fetched|true|integer (int64)
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|200|successful operation|<<Pet>>
|400|Invalid ID supplied|No Content
|404|Pet not found|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* pet
=== Deletes a pet
----
DELETE /pets/{petId}
----
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|HeaderParameter|api_key||true|string
|PathParameter|petId|Pet id to delete|true|integer (int64)
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|400|Invalid pet value|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* pet
=== Updates a pet in the store with form data
----
POST /pets/{petId}
----
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|PathParameter|petId|ID of pet that needs to be updated|true|string
|FormDataParameter|name|Updated name of the pet|true|string
|FormDataParameter|status|Updated status of the pet|true|string
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|405|Invalid input|No Content
|===
==== Consumes
* application/x-www-form-urlencoded
==== Produces
* application/json
* application/xml
==== Tags
* pet
=== Place an order for a pet
----
POST /stores/order
----
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|BodyParameter|body|order placed for purchasing the pet|false|<<Order>>
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|200|successful operation|<<Order>>
|400|Invalid Order|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* store
=== Find purchase order by ID
----
GET /stores/order/{orderId}
----
==== Description
:hardbreaks:
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|PathParameter|orderId|ID of pet that needs to be fetched|true|string
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|200|successful operation|<<Order>>
|400|Invalid ID supplied|No Content
|404|Order not found|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* store
=== Delete purchase order by ID
----
DELETE /stores/order/{orderId}
----
==== Description
:hardbreaks:
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|PathParameter|orderId|ID of the order that needs to be deleted|true|string
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content
|404|Order not found|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* store
=== Create user
----
POST /users
----
==== Description
:hardbreaks:
This can only be done by the logged in user.
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|BodyParameter|body|Created user object|false|<<User>>
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|default|successful operation|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* user
=== Creates list of users with given input array
----
POST /users/createWithArray
----
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|BodyParameter|body|List of user object|false|<<User>> array
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|default|successful operation|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* user
=== Creates list of users with given input array
----
POST /users/createWithList
----
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|BodyParameter|body|List of user object|false|<<User>> array
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|default|successful operation|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* user
=== Logs user into the system
----
GET /users/login
----
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|QueryParameter|username|The user name for login|false|string
|QueryParameter|password|The password for login in clear text|false|string
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|200|successful operation|string
|400|Invalid username/password supplied|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* user
=== Logs out current logged in user session
----
GET /users/logout
----
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|default|successful operation|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* user
=== Get user by user name
----
GET /users/{username}
----
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|PathParameter|username|The name that needs to be fetched. Use user1 for testing.|true|string
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|200|successful operation|<<User>>
|400|Invalid username supplied|No Content
|404|User not found|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* user
=== Updated user
----
PUT /users/{username}
----
==== Description
:hardbreaks:
This can only be done by the logged in user.
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|PathParameter|username|name that need to be deleted|true|string
|BodyParameter|body|Updated user object|false|<<User>>
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|400|Invalid user supplied|No Content
|404|User not found|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* user
=== Delete user
----
DELETE /users/{username}
----
==== Description
:hardbreaks:
This can only be done by the logged in user.
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|PathParameter|username|The name that needs to be deleted|true|string
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|400|Invalid username supplied|No Content
|404|User not found|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* user

View File

@@ -0,0 +1,637 @@
= Swagger Petstore
This is a sample server Petstore server.
[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.
For this sample, you can use the api key `special-key` to test the authorization filters
Version: 1.0.0
Contact: apiteam@wordnik.com
License: Apache 2.0
License URL: http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service: http://helloreverb.com/terms/
Host: petstore.swagger.wordnik.com
BasePath: /v2
Schemes: HTTP
== Paths
=== Update an existing pet
----
PUT /pets
----
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|BodyParameter|body|Pet object that needs to be added to the store|false|<<Pet>>
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content
|404|Pet not found|No Content
|405|Validation exception|No Content
|===
==== Consumes
* application/json
* application/xml
==== Produces
* application/json
* application/xml
==== Tags
* pet
=== Add a new pet to the store
----
POST /pets
----
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|BodyParameter|body|Pet object that needs to be added to the store|false|<<Pet>>
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|405|Invalid input|No Content
|===
==== Consumes
* application/json
* application/xml
==== Produces
* application/json
* application/xml
==== Tags
* pet
=== Finds Pets by status
----
GET /pets/findByStatus
----
==== Description
:hardbreaks:
Multiple status values can be provided with comma seperated strings
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|QueryParameter|status|Status values that need to be considered for filter|false|multi string array
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|200|successful operation|<<Pet>> array
|400|Invalid status value|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* pet
=== Finds Pets by tags
----
GET /pets/findByTags
----
==== Description
:hardbreaks:
Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|QueryParameter|tags|Tags to filter by|false|multi string array
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|200|successful operation|<<Pet>> array
|400|Invalid tag value|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* pet
=== Find pet by ID
----
GET /pets/{petId}
----
==== Description
:hardbreaks:
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|PathParameter|petId|ID of pet that needs to be fetched|true|integer (int64)
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|200|successful operation|<<Pet>>
|400|Invalid ID supplied|No Content
|404|Pet not found|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* pet
=== Deletes a pet
----
DELETE /pets/{petId}
----
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|HeaderParameter|api_key||true|string
|PathParameter|petId|Pet id to delete|true|integer (int64)
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|400|Invalid pet value|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* pet
=== Updates a pet in the store with form data
----
POST /pets/{petId}
----
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|PathParameter|petId|ID of pet that needs to be updated|true|string
|FormDataParameter|name|Updated name of the pet|true|string
|FormDataParameter|status|Updated status of the pet|true|string
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|405|Invalid input|No Content
|===
==== Consumes
* application/x-www-form-urlencoded
==== Produces
* application/json
* application/xml
==== Tags
* pet
=== Place an order for a pet
----
POST /stores/order
----
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|BodyParameter|body|order placed for purchasing the pet|false|<<Order>>
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|200|successful operation|<<Order>>
|400|Invalid Order|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* store
=== Find purchase order by ID
----
GET /stores/order/{orderId}
----
==== Description
:hardbreaks:
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|PathParameter|orderId|ID of pet that needs to be fetched|true|string
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|200|successful operation|<<Order>>
|400|Invalid ID supplied|No Content
|404|Order not found|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* store
=== Delete purchase order by ID
----
DELETE /stores/order/{orderId}
----
==== Description
:hardbreaks:
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|PathParameter|orderId|ID of the order that needs to be deleted|true|string
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|400|Invalid ID supplied|No Content
|404|Order not found|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* store
=== Create user
----
POST /users
----
==== Description
:hardbreaks:
This can only be done by the logged in user.
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|BodyParameter|body|Created user object|false|<<User>>
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|default|successful operation|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* user
=== Creates list of users with given input array
----
POST /users/createWithArray
----
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|BodyParameter|body|List of user object|false|<<User>> array
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|default|successful operation|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* user
=== Creates list of users with given input array
----
POST /users/createWithList
----
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|BodyParameter|body|List of user object|false|<<User>> array
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|default|successful operation|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* user
=== Logs user into the system
----
GET /users/login
----
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|QueryParameter|username|The user name for login|false|string
|QueryParameter|password|The password for login in clear text|false|string
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|200|successful operation|string
|400|Invalid username/password supplied|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* user
=== Logs out current logged in user session
----
GET /users/logout
----
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|default|successful operation|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* user
=== Get user by user name
----
GET /users/{username}
----
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|PathParameter|username|The name that needs to be fetched. Use user1 for testing.|true|string
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|200|successful operation|<<User>>
|400|Invalid username supplied|No Content
|404|User not found|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* user
=== Updated user
----
PUT /users/{username}
----
==== Description
:hardbreaks:
This can only be done by the logged in user.
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|PathParameter|username|name that need to be deleted|true|string
|BodyParameter|body|Updated user object|false|<<User>>
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|400|Invalid user supplied|No Content
|404|User not found|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* user
=== Delete user
----
DELETE /users/{username}
----
==== Description
:hardbreaks:
This can only be done by the logged in user.
==== Parameters
[options="header"]
|===
|Type|Name|Description|Required|Schema
|PathParameter|username|The name that needs to be deleted|true|string
|===
==== Responses
[options="header"]
|===
|HTTP Code|Description|Schema
|400|Invalid username supplied|No Content
|404|User not found|No Content
|===
==== Produces
* application/json
* application/xml
==== Tags
* user
== Definitions
=== User
[options="header"]
|===
|Name|Description|Schema|Required
|id||integer (int64)|false
|username||string|false
|firstName||string|false
|lastName||string|false
|email||string|false
|password||string|false
|phone||string|false
|userStatus|User Status|integer (int32)|false
|===
=== Category
[options="header"]
|===
|Name|Description|Schema|Required
|id||integer (int64)|false
|name||string|false
|===
=== Pet
[options="header"]
|===
|Name|Description|Schema|Required
|id||integer (int64)|false
|category||<<Category>>|false
|name||string|true
|photoUrls||string array|true
|tags||<<Tag>> array|false
|status|pet status in the store|string|false
|===
=== Tag
[options="header"]
|===
|Name|Description|Schema|Required
|id||integer (int64)|false
|name||string|false
|===
=== Order
[options="header"]
|===
|Name|Description|Schema|Required
|id||integer (int64)|false
|petId||integer (int64)|false
|quantity||integer (int32)|false
|shipDate||string (date-time)|false
|status|Order Status|string|false
|complete||boolean|false
|===

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,50 @@
## Definitions
### User
|Name|Description|Schema|Required|
|----|----|----|----|
|id||integer (int64)|false|
|username||string|false|
|firstName||string|false|
|lastName||string|false|
|email||string|false|
|password||string|false|
|phone||string|false|
|userStatus|User Status|integer (int32)|false|
### Category
|Name|Description|Schema|Required|
|----|----|----|----|
|id||integer (int64)|false|
|name||string|false|
### Pet
|Name|Description|Schema|Required|
|----|----|----|----|
|id||integer (int64)|false|
|category||Category|false|
|name||string|true|
|photoUrls||string array|true|
|tags||Tag array|false|
|status|pet status in the store|string|false|
### Tag
|Name|Description|Schema|Required|
|----|----|----|----|
|id||integer (int64)|false|
|name||string|false|
### Order
|Name|Description|Schema|Required|
|----|----|----|----|
|id||integer (int64)|false|
|petId||integer (int64)|false|
|quantity||integer (int32)|false|
|shipDate||string (date-time)|false|
|status|Order Status|string|false|
|complete||boolean|false|

547
src/docs/markdown/paths.md Normal file
View File

@@ -0,0 +1,547 @@
# Swagger Petstore
This is a sample server Petstore server.
[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.
For this sample, you can use the api key `special-key` to test the authorization filters
Version: 1.0.0
Contact: apiteam@wordnik.com
License: Apache 2.0
License URL: http://www.apache.org/licenses/LICENSE-2.0.html
Terms of service: http://helloreverb.com/terms/
Host: petstore.swagger.wordnik.com
BasePath: /v2
Schemes: HTTP
## Paths
### Update an existing pet
```
PUT /pets
```
### Parameters
|Type|Name|Description|Required|Schema|
|----|----|----|----|----|
|BodyParameter|body|Pet object that needs to be added to the store|false|Pet|
### Responses
|HTTP Code|Description|Schema|
|----|----|----|
|400|Invalid ID supplied|No Content|
|404|Pet not found|No Content|
|405|Validation exception|No Content|
### Consumes
* application/json
* application/xml
### Produces
* application/json
* application/xml
### Tags
* pet
### Add a new pet to the store
```
POST /pets
```
### Parameters
|Type|Name|Description|Required|Schema|
|----|----|----|----|----|
|BodyParameter|body|Pet object that needs to be added to the store|false|Pet|
### Responses
|HTTP Code|Description|Schema|
|----|----|----|
|405|Invalid input|No Content|
### Consumes
* application/json
* application/xml
### Produces
* application/json
* application/xml
### Tags
* pet
### Finds Pets by status
```
GET /pets/findByStatus
```
### Description
Multiple status values can be provided with comma seperated strings
### Parameters
|Type|Name|Description|Required|Schema|
|----|----|----|----|----|
|QueryParameter|status|Status values that need to be considered for filter|false|multi string array|
### Responses
|HTTP Code|Description|Schema|
|----|----|----|
|200|successful operation|Pet array|
|400|Invalid status value|No Content|
### Produces
* application/json
* application/xml
### Tags
* pet
### Finds Pets by tags
```
GET /pets/findByTags
```
### Description
Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
### Parameters
|Type|Name|Description|Required|Schema|
|----|----|----|----|----|
|QueryParameter|tags|Tags to filter by|false|multi string array|
### Responses
|HTTP Code|Description|Schema|
|----|----|----|
|200|successful operation|Pet array|
|400|Invalid tag value|No Content|
### Produces
* application/json
* application/xml
### Tags
* pet
### Find pet by ID
```
GET /pets/{petId}
```
### Description
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
### Parameters
|Type|Name|Description|Required|Schema|
|----|----|----|----|----|
|PathParameter|petId|ID of pet that needs to be fetched|true|integer (int64)|
### Responses
|HTTP Code|Description|Schema|
|----|----|----|
|200|successful operation|Pet|
|400|Invalid ID supplied|No Content|
|404|Pet not found|No Content|
### Produces
* application/json
* application/xml
### Tags
* pet
### Deletes a pet
```
DELETE /pets/{petId}
```
### Parameters
|Type|Name|Description|Required|Schema|
|----|----|----|----|----|
|HeaderParameter|api_key||true|string|
|PathParameter|petId|Pet id to delete|true|integer (int64)|
### Responses
|HTTP Code|Description|Schema|
|----|----|----|
|400|Invalid pet value|No Content|
### Produces
* application/json
* application/xml
### Tags
* pet
### Updates a pet in the store with form data
```
POST /pets/{petId}
```
### Parameters
|Type|Name|Description|Required|Schema|
|----|----|----|----|----|
|PathParameter|petId|ID of pet that needs to be updated|true|string|
|FormDataParameter|name|Updated name of the pet|true|string|
|FormDataParameter|status|Updated status of the pet|true|string|
### Responses
|HTTP Code|Description|Schema|
|----|----|----|
|405|Invalid input|No Content|
### Consumes
* application/x-www-form-urlencoded
### Produces
* application/json
* application/xml
### Tags
* pet
### Place an order for a pet
```
POST /stores/order
```
### Parameters
|Type|Name|Description|Required|Schema|
|----|----|----|----|----|
|BodyParameter|body|order placed for purchasing the pet|false|Order|
### Responses
|HTTP Code|Description|Schema|
|----|----|----|
|200|successful operation|Order|
|400|Invalid Order|No Content|
### Produces
* application/json
* application/xml
### Tags
* store
### Find purchase order by ID
```
GET /stores/order/{orderId}
```
### Description
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
### Parameters
|Type|Name|Description|Required|Schema|
|----|----|----|----|----|
|PathParameter|orderId|ID of pet that needs to be fetched|true|string|
### Responses
|HTTP Code|Description|Schema|
|----|----|----|
|200|successful operation|Order|
|400|Invalid ID supplied|No Content|
|404|Order not found|No Content|
### Produces
* application/json
* application/xml
### Tags
* store
### Delete purchase order by ID
```
DELETE /stores/order/{orderId}
```
### Description
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
### Parameters
|Type|Name|Description|Required|Schema|
|----|----|----|----|----|
|PathParameter|orderId|ID of the order that needs to be deleted|true|string|
### Responses
|HTTP Code|Description|Schema|
|----|----|----|
|400|Invalid ID supplied|No Content|
|404|Order not found|No Content|
### Produces
* application/json
* application/xml
### Tags
* store
### Create user
```
POST /users
```
### Description
This can only be done by the logged in user.
### Parameters
|Type|Name|Description|Required|Schema|
|----|----|----|----|----|
|BodyParameter|body|Created user object|false|User|
### Responses
|HTTP Code|Description|Schema|
|----|----|----|
|default|successful operation|No Content|
### Produces
* application/json
* application/xml
### Tags
* user
### Creates list of users with given input array
```
POST /users/createWithArray
```
### Parameters
|Type|Name|Description|Required|Schema|
|----|----|----|----|----|
|BodyParameter|body|List of user object|false|User array|
### Responses
|HTTP Code|Description|Schema|
|----|----|----|
|default|successful operation|No Content|
### Produces
* application/json
* application/xml
### Tags
* user
### Creates list of users with given input array
```
POST /users/createWithList
```
### Parameters
|Type|Name|Description|Required|Schema|
|----|----|----|----|----|
|BodyParameter|body|List of user object|false|User array|
### Responses
|HTTP Code|Description|Schema|
|----|----|----|
|default|successful operation|No Content|
### Produces
* application/json
* application/xml
### Tags
* user
### Logs user into the system
```
GET /users/login
```
### Parameters
|Type|Name|Description|Required|Schema|
|----|----|----|----|----|
|QueryParameter|username|The user name for login|false|string|
|QueryParameter|password|The password for login in clear text|false|string|
### Responses
|HTTP Code|Description|Schema|
|----|----|----|
|200|successful operation|string|
|400|Invalid username/password supplied|No Content|
### Produces
* application/json
* application/xml
### Tags
* user
### Logs out current logged in user session
```
GET /users/logout
```
### Responses
|HTTP Code|Description|Schema|
|----|----|----|
|default|successful operation|No Content|
### Produces
* application/json
* application/xml
### Tags
* user
### Get user by user name
```
GET /users/{username}
```
### Parameters
|Type|Name|Description|Required|Schema|
|----|----|----|----|----|
|PathParameter|username|The name that needs to be fetched. Use user1 for testing.|true|string|
### Responses
|HTTP Code|Description|Schema|
|----|----|----|
|200|successful operation|User|
|400|Invalid username supplied|No Content|
|404|User not found|No Content|
### Produces
* application/json
* application/xml
### Tags
* user
### Updated user
```
PUT /users/{username}
```
### Description
This can only be done by the logged in user.
### Parameters
|Type|Name|Description|Required|Schema|
|----|----|----|----|----|
|PathParameter|username|name that need to be deleted|true|string|
|BodyParameter|body|Updated user object|false|User|
### Responses
|HTTP Code|Description|Schema|
|----|----|----|
|400|Invalid user supplied|No Content|
|404|User not found|No Content|
### Produces
* application/json
* application/xml
### Tags
* user
### Delete user
```
DELETE /users/{username}
```
### Description
This can only be done by the logged in user.
### Parameters
|Type|Name|Description|Required|Schema|
|----|----|----|----|----|
|PathParameter|username|The name that needs to be deleted|true|string|
### Responses
|HTTP Code|Description|Schema|
|----|----|----|
|400|Invalid username supplied|No Content|
|404|User not found|No Content|
### Produces
* application/json
* application/xml
### Tags
* user

View File

@@ -1,9 +1,9 @@
package io.github.robwin.swagger2markup;
import com.wordnik.swagger.models.Swagger;
import io.github.robwin.markup.builder.MarkupLanguage;
import io.github.robwin.swagger2markup.builder.document.DefinitionsDocument;
import io.github.robwin.swagger2markup.builder.document.PathsDocument;
import io.github.robwin.swagger2markup.builder.markup.MarkupLanguage;
import io.swagger.parser.SwaggerParser;
import org.apache.commons.lang.Validate;
import org.slf4j.Logger;
@@ -45,10 +45,21 @@ public class Swagger2MarkupConverter {
* @return a Swagger2MarkupConverter
*/
public static Builder from(String swaggerSource){
Validate.notEmpty(swaggerSource, "swaggerSource must not be null!");
Validate.notEmpty(swaggerSource, "swaggerSource must not be empty!");
return new Builder(swaggerSource);
}
/**
* Creates a Swagger2MarkupConverter.Builder from a given Swagger model.
*
* @param swagger the Swagger source.
* @return a Swagger2MarkupConverter
*/
public static Builder from(Swagger swagger){
Validate.notNull(swagger, "swagger must not be null!");
return new Builder(swagger);
}
/**
* Builds the document with the given markup language and stores
* the files in the given folder.
@@ -61,6 +72,15 @@ public class Swagger2MarkupConverter {
buildDocuments(targetFolderPath);
}
/**
* Builds the document with the given markup language and returns it as a String
*
* @return a the document as a String
*/
public String asString() throws IOException{
return buildDocuments();
}
/**
* Writes a file for the Paths (API) and a file for the Definitions (Model)
@@ -72,6 +92,16 @@ public class Swagger2MarkupConverter {
new DefinitionsDocument(swagger, markupLanguage, schemasFolderPath).build().writeToFile(directory, DEFINITIONS_DOCUMENT, StandardCharsets.UTF_8);
}
/**
* Returns a file for the Paths (API) and a file for the Definitions (Model)
* @return a the document as a String
*/
private String buildDocuments() throws IOException {
return new PathsDocument(swagger, markupLanguage, examplesFolderPath).build().toString()
.concat(new DefinitionsDocument(swagger, markupLanguage, schemasFolderPath).build().toString());
}
public static class Builder{
private final Swagger swagger;
@@ -88,6 +118,17 @@ public class Swagger2MarkupConverter {
swagger = new SwaggerParser().read(swaggerSource);
}
/**
* Creates a Builder using a given Swagger model.
*
* @param swagger the Swagger source.
*/
Builder(Swagger swagger){
this.swagger = swagger;
}
public Swagger2MarkupConverter build(){
return new Swagger2MarkupConverter(markupLanguage, swagger, examplesFolderPath, schemasFolderPath);
}

View File

@@ -2,8 +2,10 @@ package io.github.robwin.swagger2markup.builder.document;
import com.wordnik.swagger.models.Model;
import com.wordnik.swagger.models.Swagger;
import com.wordnik.swagger.models.properties.AbstractProperty;
import com.wordnik.swagger.models.properties.Property;
import io.github.robwin.swagger2markup.builder.markup.MarkupLanguage;
import io.github.robwin.markup.builder.MarkupLanguage;
import io.github.robwin.swagger2markup.utils.PropertyUtils;
import org.apache.commons.collections.MapUtils;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang.StringUtils;
@@ -18,11 +20,7 @@ import java.util.List;
import java.util.Map;
/**
* Project: swagger2markup
* Copyright: Deutsche Telekom AG
*
* @author Robert Winkler <robert.winkler@telekom.de>
* @since 2.0.0
* @author Robert Winkler
*/
public class DefinitionsDocument extends MarkupDocument {
@@ -30,8 +28,6 @@ public class DefinitionsDocument extends MarkupDocument {
private static final List<String> IGNORED_DEFINITIONS = Arrays.asList("Void");
private static final String JSON_SCHEMA = "JSON Schema";
private static final String XML_SCHEMA = "XML Schema";
private static final String NAME_COLUMN = "Name";
private static final String TYPE_COLUMN = "Type";
public static final String JSON_SCHEMA_EXTENSION = ".json";
public static final String XML_SCHEMA_EXTENSION = ".xsd";
public static final String JSON = "json";
@@ -69,7 +65,7 @@ public class DefinitionsDocument extends MarkupDocument {
*/
private void definitions(Map<String, Model> definitions) throws IOException {
if(MapUtils.isNotEmpty(definitions)){
this.documentBuilder.sectionTitleLevel1(DEFINITIONS);
this.markupDocBuilder.sectionTitleLevel1(DEFINITIONS);
for(Map.Entry<String, Model> definitionsEntry : definitions.entrySet()){
String definitionName = definitionsEntry.getKey();
if(StringUtils.isNotBlank(definitionName)) {
@@ -106,15 +102,26 @@ public class DefinitionsDocument extends MarkupDocument {
* @param model the Swagger Model of the definition
*/
private void definition(String definitionName, Model model) {
this.documentBuilder.sectionTitleLevel2(definitionName);
this.markupDocBuilder.sectionTitleLevel2(definitionName);
Map<String, Property> properties = model.getProperties();
List<String> csvContent = new ArrayList<>();
csvContent.add(NAME_COLUMN + DELIMITER + TYPE_COLUMN + DELIMITER + REQUIRED_COLUMN);
for (Map.Entry<String, Property> propertyEntry : properties.entrySet()) {
Property property = propertyEntry.getValue();
csvContent.add(propertyEntry.getKey() + DELIMITER + property.getType() + DELIMITER + property.getRequired());
List<String> headerAndContent = new ArrayList<>();
List<String> header = Arrays.asList(NAME_COLUMN, DESCRIPTION_COLUMN, SCHEMA_COLUMN, REQUIRED_COLUMN);
headerAndContent.add(StringUtils.join(header, DELIMITER));
if(MapUtils.isNotEmpty(properties)){
for (Map.Entry<String, Property> propertyEntry : properties.entrySet()) {
Property property = propertyEntry.getValue();
String description = "";
if(property instanceof AbstractProperty){
if(StringUtils.isNotBlank(property.getDescription())){
description = property.getDescription();
}
}
String type = PropertyUtils.getType(property, markupLanguage);
List<String> content = Arrays.asList(propertyEntry.getKey(), description, type, Boolean.toString(property.getRequired()));
headerAndContent.add(StringUtils.join(content, DELIMITER));
}
this.markupDocBuilder.tableWithHeaderRow(headerAndContent);
}
this.documentBuilder.tableWithHeaderRow(csvContent);
}
private void definitionSchema(String definitionName) throws IOException {
@@ -129,8 +136,8 @@ public class DefinitionsDocument extends MarkupDocument {
private void schema(String title, String schemasFolderPath, String schemaName, String language) throws IOException {
java.nio.file.Path path = Paths.get(schemasFolderPath, schemaName);
if (Files.isReadable(path)) {
this.documentBuilder.sectionTitleLevel3(title);
this.documentBuilder.source(FileUtils.readFileToString(path.toFile(), StandardCharsets.UTF_8).trim(), language);
this.markupDocBuilder.sectionTitleLevel3(title);
this.markupDocBuilder.source(FileUtils.readFileToString(path.toFile(), StandardCharsets.UTF_8).trim(), language);
if (logger.isInfoEnabled()) {
logger.info("Schema file processed: {}", path);
}

View File

@@ -1,9 +1,9 @@
package io.github.robwin.swagger2markup.builder.document;
import com.wordnik.swagger.models.Swagger;
import io.github.robwin.swagger2markup.builder.markup.DocumentBuilder;
import io.github.robwin.swagger2markup.builder.markup.DocumentBuilders;
import io.github.robwin.swagger2markup.builder.markup.MarkupLanguage;
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;
@@ -11,25 +11,25 @@ import java.io.IOException;
import java.nio.charset.Charset;
/**
* Project: swagger2markup
* Copyright: Deutsche Telekom AG
*
* @author Robert Winkler <robert.winkler@telekom.de>
* @since 2.0.0
* @author Robert Winkler
*/
public abstract class MarkupDocument {
protected static final String DELIMITER = ",";
protected static final String DELIMITER = "|";
protected static final String REQUIRED_COLUMN = "Required";
protected static final String SCHEMA_COLUMN = "Schema";
protected static final String NAME_COLUMN = "Name";
protected static final String DESCRIPTION_COLUMN = "Description";
protected static final String DESCRIPTION = DESCRIPTION_COLUMN;
protected Logger logger = LoggerFactory.getLogger(getClass());
protected Swagger swagger;
protected MarkupLanguage markupLanguage;
protected DocumentBuilder documentBuilder;
protected MarkupDocBuilder markupDocBuilder;
MarkupDocument(Swagger swagger, MarkupLanguage markupLanguage){
this.swagger = swagger;
this.markupLanguage = markupLanguage;
this.documentBuilder = DocumentBuilders.documentBuilder(markupLanguage);
this.markupDocBuilder = MarkupDocBuilders.documentBuilder(markupLanguage);
}
/**
@@ -44,7 +44,7 @@ public abstract class MarkupDocument {
* Returns a string representation of the document.
*/
public String toString(){
return documentBuilder.toString();
return markupDocBuilder.toString();
}
/**
@@ -56,6 +56,6 @@ public abstract class MarkupDocument {
* @throws IOException if the file cannot be written
*/
public void writeToFile(String directory, String fileName, Charset charset) throws IOException{
documentBuilder.writeToFile(directory, fileName, charset);
markupDocBuilder.writeToFile(directory, fileName, charset);
}
}

View File

@@ -2,43 +2,51 @@ package io.github.robwin.swagger2markup.builder.document;
import com.wordnik.swagger.models.*;
import com.wordnik.swagger.models.parameters.Parameter;
import io.github.robwin.swagger2markup.builder.markup.MarkupLanguage;
import com.wordnik.swagger.models.properties.Property;
import io.github.robwin.markup.builder.MarkupLanguage;
import io.github.robwin.swagger2markup.utils.ParameterUtils;
import io.github.robwin.swagger2markup.utils.PropertyUtils;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.collections.MapUtils;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.WordUtils;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
/**
* Project: swagger2markup
* Copyright: Deutsche Telekom AG
*
* @author Robert Winkler <robert.winkler@telekom.de>
* @since 2.0.0
* @author Robert Winkler
*/
public class PathsDocument extends MarkupDocument {
private static final String PATHS = "Paths";
private static final String VERSION = "Version: ";
private static final String DESCRIPTION_COLUMN = "Description";
private static final String DESCRIPTION = DESCRIPTION_COLUMN;
private static final String CONTACT_NAME = "Contact: ";
private static final String CONTACT_EMAIL = "Contact Email: ";
private static final String LICENSE = "License: ";
private static final String LICENSE_URL = "License URL: ";
private static final String TERMS_OF_SERVICE = "Terms of service: ";
private static final String HOST = "Host: ";
private static final String BASE_PATH = "BasePath: ";
private static final String SCHEMES = "Schemes: ";
private static final String PARAMETERS = "Parameters";
private static final String PRODUCES = "Produces";
private static final String CONSUMES = "Consumes";
private static final String TAGS = "Tags";
private static final String RESPONSES = "Responses";
private static final String EXAMPLE_REQUEST = "Example request";
private static final String EXAMPLE_RESPONSE = "Example response";
private static final String NAME_COLUMN = "Name";
private static final String LOCATED_IN_COLUMN = "Located in";
private static final String CODE_COLUMN = "Code";
public static final String REQUEST_EXAMPLE_FILE_NAME = "request";
public static final String RESPONSE_EXAMPLE_FILE_NAME = "response";
private static final String TYPE_COLUMN = "Type";
private static final String HTTP_CODE_COLUMN = "HTTP Code";
private static final String REQUEST_EXAMPLE_FILE_NAME = "request";
private static final String RESPONSE_EXAMPLE_FILE_NAME = "response";
private boolean examplesEnabled;
private String examplesFolderPath;
@@ -62,39 +70,78 @@ public class PathsDocument extends MarkupDocument {
@Override
public MarkupDocument build() throws IOException {
documentHeader(swagger.getInfo());
paths(swagger.getPaths());
documentHeader();
paths();
return this;
}
/**
* Builds the document header
*
* @param info the Swagger Info
* Builds the document header of the swagger model
*/
private void documentHeader(Info info) {
this.documentBuilder
.documentTitle(info.getTitle())
.textLine(info.getDescription())
.textLine(VERSION + info.getVersion())
.newLine();
private void documentHeader() {
Info info = swagger.getInfo();
this.markupDocBuilder.documentTitle(info.getTitle());
if(StringUtils.isNotBlank(info.getDescription())){
this.markupDocBuilder.textLine(info.getDescription());
}
if(StringUtils.isNotBlank(info.getVersion())){
this.markupDocBuilder.textLine(VERSION + info.getVersion());
}
Contact contact = info.getContact();
if(contact != null){
if(StringUtils.isNotBlank(contact.getName())){
this.markupDocBuilder.textLine(CONTACT_NAME + contact.getName());
}
if(StringUtils.isNotBlank(contact.getEmail())){
this.markupDocBuilder.textLine(CONTACT_EMAIL + contact.getEmail());
}
}
License license = info.getLicense();
if(license != null) {
if (StringUtils.isNotBlank(license.getName())) {
this.markupDocBuilder.textLine(LICENSE + license.getName());
}
if (StringUtils.isNotBlank(license.getUrl())) {
this.markupDocBuilder.textLine(LICENSE_URL + license.getUrl());
}
}
if(StringUtils.isNotBlank(info.getTermsOfService())){
this.markupDocBuilder.textLine(TERMS_OF_SERVICE + info.getTermsOfService());
}
this.markupDocBuilder.newLine();
if(StringUtils.isNotBlank(swagger.getHost())){
this.markupDocBuilder.textLine(HOST + swagger.getHost());
}
if(StringUtils.isNotBlank(swagger.getBasePath())){
this.markupDocBuilder.textLine(BASE_PATH + swagger.getBasePath());
}
if(CollectionUtils.isNotEmpty(swagger.getSchemes())){
List<String> schemes = new ArrayList<>();
for(Scheme scheme : swagger.getSchemes()){
schemes.add(scheme.toString());
}
this.markupDocBuilder.textLine(SCHEMES + StringUtils.join(schemes, ", "));
}
this.markupDocBuilder.newLine();
}
/**
* Builds all paths of the Swagger file
*
* @param paths a Map of Swagger Paths
* Builds all paths of the Swagger model
*/
private void paths(Map<String, Path> paths) throws IOException {
private void paths() throws IOException {
Map<String, Path> paths = swagger.getPaths();
if(MapUtils.isNotEmpty(paths)) {
//this.documentBuilder.sectionTitleLevel1(FEATURES);
this.markupDocBuilder.sectionTitleLevel1(PATHS);
for (Map.Entry<String, Path> entry : paths.entrySet()) {
Path path = entry.getValue();
path("GET", entry.getKey(), path.getGet());
path("PUT", entry.getKey(), path.getPut());
path("DELETE", entry.getKey(), path.getDelete());
path("POST", entry.getKey(), path.getPost());
path("PATCH", entry.getKey(), path.getPatch());
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());
}
}
}
}
@@ -114,21 +161,21 @@ public class PathsDocument extends MarkupDocument {
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.documentBuilder.sectionTitleLevel1(title);
this.documentBuilder.listing(httpMethod + " " + resourcePath);
this.markupDocBuilder.sectionTitleLevel2(title);
this.markupDocBuilder.listing(httpMethod + " " + resourcePath);
}else{
title = httpMethod + " " + resourcePath;
this.documentBuilder.sectionTitleLevel1(title);
this.markupDocBuilder.sectionTitleLevel2(title);
}
if (logger.isInfoEnabled()) {
logger.info("Path processed: {}", title);
@@ -138,29 +185,35 @@ public class PathsDocument extends MarkupDocument {
private void descriptionSection(Operation operation) {
String description = operation.getDescription();
if(StringUtils.isNotBlank(description)){
this.documentBuilder.sectionTitleLevel2(DESCRIPTION);
this.documentBuilder.paragraph(description);
this.markupDocBuilder.sectionTitleLevel3(DESCRIPTION);
this.markupDocBuilder.paragraph(description);
}
}
private void parametersSection(Operation operation) {
List<Parameter> parameters = operation.getParameters();
if(CollectionUtils.isNotEmpty(parameters)){
List<String> csvContent = new ArrayList<>();
csvContent.add(NAME_COLUMN + DELIMITER + LOCATED_IN_COLUMN + DELIMITER + DESCRIPTION_COLUMN + DELIMITER + REQUIRED_COLUMN);
List<String> headerAndContent = new ArrayList<>();
// Table header row
List<String> header = Arrays.asList(TYPE_COLUMN, NAME_COLUMN, DESCRIPTION_COLUMN, REQUIRED_COLUMN, SCHEMA_COLUMN);
headerAndContent.add(StringUtils.join(header, DELIMITER));
for(Parameter parameter : parameters){
csvContent.add(parameter.getName() + DELIMITER + parameter.getIn() + DELIMITER + parameter.getDescription() + DELIMITER + parameter.getRequired());
String type = ParameterUtils.getType(parameter, markupLanguage);
String parameterType = WordUtils.capitalize(parameter.getIn() + "Parameter");
// Table content row
List<String> content = Arrays.asList(parameterType, parameter.getName(), parameter.getDescription(), Boolean.toString(parameter.getRequired()), type);
headerAndContent.add(StringUtils.join(content, DELIMITER));
}
this.documentBuilder.sectionTitleLevel2(PARAMETERS);
this.documentBuilder.tableWithHeaderRow(csvContent);
this.markupDocBuilder.sectionTitleLevel3(PARAMETERS);
this.markupDocBuilder.tableWithHeaderRow(headerAndContent);
}
}
private void consumesSection(Operation operation) {
List<String> consumes = operation.getConsumes();
if(CollectionUtils.isNotEmpty(consumes)){
this.documentBuilder.sectionTitleLevel2(CONSUMES);
this.documentBuilder.unorderedList(consumes);
this.markupDocBuilder.sectionTitleLevel3(CONSUMES);
this.markupDocBuilder.unorderedList(consumes);
}
}
@@ -168,8 +221,16 @@ public class PathsDocument extends MarkupDocument {
private void producesSection(Operation operation) {
List<String> produces = operation.getProduces();
if(CollectionUtils.isNotEmpty(produces)){
this.documentBuilder.sectionTitleLevel2(PRODUCES);
this.documentBuilder.unorderedList(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);
}
}
@@ -202,8 +263,8 @@ public class PathsDocument extends MarkupDocument {
for (String fileNameExtension : markupLanguage.getFileNameExtensions()) {
java.nio.file.Path path = Paths.get(examplesFolderPath, exampleFolder, exampleFileName + fileNameExtension);
if (Files.isReadable(path)) {
this.documentBuilder.sectionTitleLevel2(title);
this.documentBuilder.paragraph(FileUtils.readFileToString(path.toFile(), StandardCharsets.UTF_8).trim());
this.markupDocBuilder.sectionTitleLevel3(title);
this.markupDocBuilder.paragraph(FileUtils.readFileToString(path.toFile(), StandardCharsets.UTF_8).trim());
if (logger.isInfoEnabled()) {
logger.info("Example file processed: {}", path);
}
@@ -220,13 +281,19 @@ public class PathsDocument extends MarkupDocument {
Map<String, Response> responses = operation.getResponses();
if(MapUtils.isNotEmpty(responses)){
List<String> csvContent = new ArrayList<>();
csvContent.add(CODE_COLUMN + DELIMITER + DESCRIPTION_COLUMN);
csvContent.add(HTTP_CODE_COLUMN + DELIMITER + DESCRIPTION_COLUMN + DELIMITER + SCHEMA_COLUMN);
for(Map.Entry<String, Response> entry : responses.entrySet()){
Response response = entry.getValue();
csvContent.add(entry.getKey() + DELIMITER + response.getDescription());
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.documentBuilder.sectionTitleLevel2(RESPONSES);
this.documentBuilder.tableWithHeaderRow(csvContent);
this.markupDocBuilder.sectionTitleLevel3(RESPONSES);
this.markupDocBuilder.tableWithHeaderRow(csvContent);
}
}

View File

@@ -1,97 +0,0 @@
package io.github.robwin.swagger2markup.builder.markup;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.BufferedWriter;
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.Paths;
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 Logger logger = LoggerFactory.getLogger(getClass());
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);
}
@Override
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);
}
protected 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);
}
@Override
public DocumentBuilder newLine(){
documentBuilder.append(newLine);
return this;
}
@Override
public String toString(){
return documentBuilder.toString();
}
@Override
public void writeToFile(String directory, String fileNameWithExtension, Charset charset) throws IOException {
Files.createDirectories(Paths.get(directory));
try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(directory, fileNameWithExtension), charset)){
writer.write(documentBuilder.toString());
}
if (logger.isInfoEnabled()) {
logger.info("{} was written to: {}", fileNameWithExtension, directory);
}
documentBuilder = new StringBuilder();
}
}

View File

@@ -1,51 +0,0 @@
package io.github.robwin.swagger2markup.builder.markup;
import java.io.IOException;
import java.nio.charset.Charset;
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 source(String text, String language);
DocumentBuilder boldTextLine(String text);
DocumentBuilder italicTextLine(String text);
DocumentBuilder unorderedList(List<String> list);
DocumentBuilder tableWithHeaderRow(List<String> rowsInCSV);
DocumentBuilder newLine();
/**
* Returns a string representation of the document.
*/
String 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
*/
void writeToFile(String directory, String fileName, Charset charset) throws IOException;
}

View File

@@ -1,25 +0,0 @@
package io.github.robwin.swagger2markup.builder.markup;
import io.github.robwin.swagger2markup.builder.markup.asciidoc.AsciiDocBuilder;
import io.github.robwin.swagger2markup.builder.markup.markdown.MarkdownBuilder;
/**
* Project: swagger2markup
* Copyright: Deutsche Telekom AG
*
* @author Robert Winkler <robert.winkler@telekom.de>
* @since 2.0.0
*/
public final class DocumentBuilders {
private DocumentBuilders(){};
public static DocumentBuilder documentBuilder(MarkupLanguage markupLanguage){
switch(markupLanguage){
case MARKDOWN: return new MarkdownBuilder();
case ASCIIDOC: return new AsciiDocBuilder();
default: return new AsciiDocBuilder();
}
}
}

View File

@@ -1,12 +0,0 @@
package io.github.robwin.swagger2markup.builder.markup;
/**
* 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,25 +0,0 @@
package io.github.robwin.swagger2markup.builder.markup;
import java.util.Arrays;
import java.util.List;
/**
* @author Robert Winkler
*/
public enum MarkupLanguage {
ASCIIDOC(".adoc,.asciidoc"),
MARKDOWN(".md,.markdown");
private final String fileNameExtensions;
/**
* @param fileNameExtensions file name suffix
*/
private MarkupLanguage(final String fileNameExtensions) {
this.fileNameExtensions = fileNameExtensions;
}
public List<String> getFileNameExtensions() {
return Arrays.asList(fileNameExtensions.split(","));
}
}

View File

@@ -1,37 +0,0 @@
package io.github.robwin.swagger2markup.builder.markup.asciidoc;
import io.github.robwin.swagger2markup.builder.markup.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,93 +0,0 @@
package io.github.robwin.swagger2markup.builder.markup.asciidoc;
import io.github.robwin.swagger2markup.builder.markup.AbstractDocumentBuilder;
import io.github.robwin.swagger2markup.builder.markup.DocumentBuilder;
import java.io.IOException;
import java.nio.charset.Charset;
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 source(String text, String language){
documentBuilder.append(String.format("[source,%s]", language)).append(newLine);
listing(AsciiDoc.LISTING, text);
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;
}
@Override
public void writeToFile(String directory, String fileName, Charset charset) throws IOException {
String fileNameWithExtension = fileName + ".adoc";
super.writeToFile(directory, fileNameWithExtension, charset);
}
}

View File

@@ -1,41 +0,0 @@
package io.github.robwin.swagger2markup.builder.markup.markdown;
import io.github.robwin.swagger2markup.builder.markup.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,120 +0,0 @@
package io.github.robwin.swagger2markup.builder.markup.markdown;
import io.github.robwin.swagger2markup.builder.markup.AbstractDocumentBuilder;
import io.github.robwin.swagger2markup.builder.markup.DocumentBuilder;
import java.io.IOException;
import java.nio.charset.Charset;
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 source(String text, String language){
documentBuilder.append(Markdown.LISTING).append(language).append(newLine).
append(text).append(newLine).
append(Markdown.LISTING).append(newLine).append(newLine);
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;
}
@Override
public void writeToFile(String directory, String fileName, Charset charset) throws IOException {
String fileNameWithExtension = fileName + ".md";
super.writeToFile(directory, fileNameWithExtension, charset);
}
}

View File

@@ -0,0 +1,27 @@
package io.github.robwin.swagger2markup.utils;
import com.wordnik.swagger.models.ArrayModel;
import com.wordnik.swagger.models.Model;
import com.wordnik.swagger.models.ModelImpl;
import com.wordnik.swagger.models.RefModel;
import io.github.robwin.markup.builder.MarkupLanguage;
import org.apache.commons.lang.Validate;
public final class ModelUtils {
public static String getType(Model model, MarkupLanguage markupLanguage) {
Validate.notNull(model, "model must not be null!");
if (model instanceof ModelImpl) {
return ((ModelImpl) model).getType();
} else if (model instanceof RefModel) {
switch (markupLanguage){
case ASCIIDOC: return "<<" + ((RefModel) model).getSimpleRef() + ">>";
default: return ((RefModel) model).getSimpleRef();
}
} else if (model instanceof ArrayModel) {
ArrayModel arrayModel = ((ArrayModel) model);
return PropertyUtils.getType(arrayModel.getItems(), markupLanguage) + " " + arrayModel.getType();
}
return "NOT FOUND";
}
}

View File

@@ -0,0 +1,62 @@
package io.github.robwin.swagger2markup.utils;
import com.wordnik.swagger.models.Model;
import com.wordnik.swagger.models.parameters.*;
import io.github.robwin.markup.builder.MarkupLanguage;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.Validate;
public final class ParameterUtils {
public static String getType(Parameter parameter, MarkupLanguage markupLanguage){
Validate.notNull(parameter, "property must not be null!");
String type = "NOT FOUND";
if(parameter instanceof BodyParameter){
BodyParameter bodyParameter = (BodyParameter)parameter;
Model model = bodyParameter.getSchema();
type = ModelUtils.getType(model, markupLanguage);
}
else if(parameter instanceof PathParameter){
PathParameter pathParameter = (PathParameter)parameter;
type = getTypeWithFormat(pathParameter.getType(), pathParameter.getFormat());
}
else if(parameter instanceof QueryParameter){
QueryParameter queryParameter = (QueryParameter)parameter;
type = getTypeWithFormat(queryParameter.getType(), queryParameter.getFormat());
if(type.equals("array")){
String collectionFormat = queryParameter.getCollectionFormat();
type = collectionFormat + " " + PropertyUtils.getType(queryParameter.getItems(), markupLanguage) + " " + type;
}
}
else if(parameter instanceof HeaderParameter){
HeaderParameter headerParameter = (HeaderParameter)parameter;
type = getTypeWithFormat(headerParameter.getType(), headerParameter.getFormat());
}
else if(parameter instanceof FormParameter){
FormParameter formParameter = (FormParameter)parameter;
type = formParameter.getType();
}
else if(parameter instanceof CookieParameter){
CookieParameter cookieParameter = (CookieParameter)parameter;
type = getTypeWithFormat(cookieParameter.getType(), cookieParameter.getFormat());
}
else if(parameter instanceof RefParameter){
RefParameter refParameter = (RefParameter)parameter;
switch (markupLanguage){
case ASCIIDOC: return "<<" + refParameter.getSimpleRef() + ">>";
default: return refParameter.getSimpleRef();
}
}
return type;
}
private static String getTypeWithFormat(String typeWithoutFormat, String format) {
String type;
if(StringUtils.isNotBlank(format)){
type = typeWithoutFormat + " (" + format + ")";
}else{
type = typeWithoutFormat;
}
return type;
}
}

View File

@@ -0,0 +1,47 @@
package io.github.robwin.swagger2markup.utils;
import com.wordnik.swagger.models.properties.ArrayProperty;
import com.wordnik.swagger.models.properties.Property;
import com.wordnik.swagger.models.properties.RefProperty;
import com.wordnik.swagger.models.properties.StringProperty;
import io.github.robwin.markup.builder.MarkupLanguage;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.Validate;
import java.util.List;
public final class PropertyUtils {
public static String getType(Property property, MarkupLanguage markupLanguage){
Validate.notNull(property, "property must not be null!");
String type;
if(property instanceof RefProperty){
RefProperty refProperty = (RefProperty)property;
switch (markupLanguage){
case ASCIIDOC: return "<<" + refProperty.getSimpleRef() + ">>";
default: return refProperty.getSimpleRef();
}
}else if(property instanceof ArrayProperty){
ArrayProperty arrayProperty = (ArrayProperty)property;
Property items = arrayProperty.getItems();
type = getType(items, markupLanguage) + " " + arrayProperty.getType();
}else if(property instanceof StringProperty){
StringProperty stringProperty = (StringProperty)property;
List<String> enums = stringProperty.getEnum();
if(CollectionUtils.isNotEmpty(enums)){
type = "enum" + " (" + StringUtils.join(enums, ", ") + ")";
}else{
type = property.getType();
}
}
else{
if(StringUtils.isNotBlank(property.getFormat())){
type = property.getType() + " (" + property.getFormat() + ")";
}else{
type = property.getType();
}
}
return type;
}
}

View File

@@ -1,12 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true">
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="CONSOLE" />
</root>
</configuration>

View File

@@ -1,10 +1,15 @@
package io.github.robwin.swagger2markup;
import io.github.robwin.swagger2markup.builder.markup.MarkupLanguage;
import io.github.robwin.markup.builder.MarkupLanguage;
import org.asciidoctor.*;
import org.junit.Test;
import java.io.BufferedWriter;
import java.io.File;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Paths;
/**
* @author Robert Winkler
@@ -12,7 +17,7 @@ import java.io.IOException;
public class Swagger2MarkupConverterTest {
@Test
public void testSwagger2AsciiDocConverter() throws IOException {
public void testSwagger2MarkupConversion() throws IOException {
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/swagger.json").getFile());
Swagger2MarkupConverter.from(file.getAbsolutePath()).
@@ -25,4 +30,37 @@ public class Swagger2MarkupConverterTest {
.intoFolder("src/docs/asciidoc");
}
@Test
public void testSwagger2HtmlConversion() throws IOException {
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/swagger.json").getFile());
String asciiDoc = Swagger2MarkupConverter.from(file.getAbsolutePath()).build().asString();
String path = "src/docs/asciidocAsString";
Files.createDirectories(Paths.get(path));
try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(path, "swagger.adoc"), StandardCharsets.UTF_8)){
writer.write(asciiDoc); }
String asciiDocAsHtml = Asciidoctor.Factory.create().convert(asciiDoc,
OptionsBuilder.options().backend("html5").headerFooter(true).safe(SafeMode.UNSAFE).docType("book").attributes(AttributesBuilder.attributes()
.tableOfContents(true).tableOfContents(Placement.LEFT).sectionNumbers(true).hardbreaks(true).setAnchors(true).attribute("sectlinks")));
try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(path, "swagger.html"), StandardCharsets.UTF_8)){
writer.write(asciiDocAsHtml);
}
}
/*
@Test
public void testSwagger2PdfConversion() throws IOException {
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/spica.json").getFile());
String asciiDoc = Swagger2MarkupConverter.from(file.getAbsolutePath()).build().asString();
String path = "src/docs/asciidocAsString";
Files.createDirectories(Paths.get(path));
try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(path, "spica.adoc"), StandardCharsets.UTF_8)){
writer.write(asciiDoc);
}
String asciiDocAsPdf= Asciidoctor.Factory.create().convert(asciiDoc, OptionsBuilder.options().backend("pdf"));
try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(path, "spica.pdf"), StandardCharsets.UTF_8)){
writer.write(asciiDocAsPdf);
}
}
*/
}

View File

@@ -1,26 +0,0 @@
package io.github.robwin.swagger2markup.builder;
import io.github.robwin.swagger2markup.builder.markup.DocumentBuilder;
import io.github.robwin.swagger2markup.builder.markup.DocumentBuilders;
import io.github.robwin.swagger2markup.builder.markup.MarkupLanguage;
import org.junit.Test;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
/**
* Project: swagger2markup
* Copyright: Deutsche Telekom AG
*
* @author Robert Winkler <robert.winkler@telekom.de>
* @since 2.0.0
*/
public class DocumentBuilderTest {
@Test
public void testToFile() throws IOException {
DocumentBuilder builder = DocumentBuilders.documentBuilder(MarkupLanguage.ASCIIDOC);
builder.documentTitle("Test title").textLine("Text line").writeToFile("/tmp", "test.adoc", StandardCharsets.UTF_8);
}
}