Fixed markup-document-builder version dependency

Merge pull request #3 from RobWin/master
fixed wrong dependency
2015-03-23 08:59:49 +01:00 · 2015-03-17 12:11:42 +01:00 · 2015-03-17 12:01:38 +01:00 · 2015-02-20 11:02:23 +01:00 · 2015-02-20 10:13:32 +01:00 · 2015-02-20 10:13:01 +01:00
26 changed files with 840 additions and 1670 deletions
--- a/README.adoc
+++ b/README.adoc
@@ -1,21 +1,61 @@
 = Swagger2Markup
 :author: Robert Winkler
-:version: 0.1.0
+:version: 0.2.1
 :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"]
-
-WARNING: Still under heavy development
+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"]

 == 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/spring-projects/spring-restdocs[spring-restdocs]. See <<integration-with-spring-restdocs, Integration with spring-restdocs>>.
+
+The project requires at least JDK 7.

 == Usage

-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:
+=== Adding Swagger2Markup to your project
+The project is published in JCenter and Maven Central.
+
+==== Maven
+
+[source,xml]
+----
+<repositories>
+    <repository>
+        <snapshots>
+            <enabled>false</enabled>
+        </snapshots>
+        <id>central</id>
+        <name>bintray</name>
+        <url>http://jcenter.bintray.com</url>
+    </repository>
+</repositories>
+
+<dependency>
+    <groupId>io.github.robwin</groupId>
+    <artifactId>swagger2markup</artifactId>
+    <version>0.2.1</version>
+</dependency>
+----
+
+==== Gradle
+
+[source,groovy]
+----
+repositories {
+    jcenter()
+}
+
+compile "io.github.robwin:swagger2markup:0.2.1"
+----
+
+=== Using Swagger2Markup
+
+Using the Swagger2MarkupConverter is simple. For instance, you can generate your AsciiDoc/Markdown documentation using https://github.com/spring-projects/spring-boot[Spring Boot] and https://github.com/martypitt/swagger-springmvc[swagger-springmvc] as follows.
+See demo project https://github.com/RobWin/spring-swagger2markup-demo[spring-swagger2markup-demo].

 [source,java]
 ----
@@ -27,18 +67,23 @@ public class Swagger2MarkupTest {

    @Test
    public void convertSwaggerToMarkup() {
-        //Remote
+        //Remote Swagger source
+        //Markdown
        Swagger2MarkupConverter.from("http://localhost:8080/api-docs").
-            toAsciiDoc("src/docs/asciidoc/example.adoc");
+                withMarkupLanguage(MarkupLanguage.MARKDOWN).build()
+                .intoFolder("src/docs/markdown");

-        Swagger2MarkupConverter.from("http://localhost:8080/api-docs").
-            toMarkdown("src/docs/markdown/example.md");
+        //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()).toAsciiDoc("src/docs/asciidoc/swagger.adoc")
+        Swagger2MarkupConverter.from(file.getAbsolutePath()).build()
+                        .intoFolder("src/docs/asciidoc");
    }
-
 }
 ----

@@ -75,30 +120,94 @@ public class SpringBootSwaggerConfig {
 }
 ----

-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].
+You can generate your HTML5 and PDF documentation via https://github.com/asciidoctor/asciidoctorj[asciidoctorj] or even better via the https://github.com/asciidoctor/asciidoctor-gradle-plugin[asciidoctor-gradle-plugin] or https://github.com/aalmiray/markdown-gradle-plugin[markdown-gradle-plugin].
+You can also use https://github.com/tomchristie/mkdocs[MkDocs] and https://github.com/rtfd/readthedocs.org[ReadTheDocs] to publish your Markdown documentation.
+See http://spring-swagger2markup-demo.readthedocs.org/[ReadTheDocs-demo]

-== Example
-== swagger.json
+== Examples
+== Swagger source file
 image::images/swagger_json.PNG[swagger_json]

 === Generated AsciiDoc file
 image::images/asciidoc.PNG[asciidoc]

 === Generated Markdown file
-image::images/markdown.PNG[asciidoc]
+image::images/markdown.PNG[markdown]

-=== Generated HTML
+=== Generated HTML using AsciidoctorJ
 image::images/asciidoc_html.PNG[asciidoc_html]

-== Document Builder
-The converter allows to build an AsciiDoc or Markdown document via the Builder pattern:
+=== Generated HTML using Mkdocs
+image::images/mkdocs_html.PNG[mkdocs_html]
+
+=== Generated PDF using AsciidoctorJ
+image::images/asciidoc_pdf.PNG[asciidoc_pdf]
+
+
+== Integration with spring-restdocs
+https://github.com/spring-projects/spring-restdocs[spring-restdocs] can be used together with Swagger2Markup.
+Swagger2Markup can include the generated examples from spring-restdocs into the generated AsciiDoc document.
+Currently it does not work for Markdown, since spring-restdocs generates only AsciiDoc files.
+
+Let's say I have a Swagger-annotated Spring RestController method with an ApiOperation value: _"Create a quota"_
+
 [source,java]
 ----
-        String asciiDoc = new AsciiDocBuilder().documentTitle("Title")
-                .sectionTitleLevel1("Section1").paragraph("Text text")
-                .sectionTitleLevel2("Code examples").listing("Code example").toString();
-
-        String markdown = new MarkdownBuilder().documentTitle("Title")
-                .sectionTitleLevel1("Section1").paragraph("Text text")
-                .sectionTitleLevel2("Code examples").listing("Code example").toString();
+@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]
--- a/RELEASENOTES.adoc
+++ b/RELEASENOTES.adoc
@@ -1,4 +1,10 @@
 = 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
--- a/build.gradle
+++ b/build.gradle
@@ -6,22 +6,18 @@ 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 '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'
    }
 }
 description = 'swagger2markup Build'
-version = '0.1.0'
-group = 'io.swagger2markup'
+version = '0.2.2'
+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'
@@ -40,30 +36,52 @@ 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'
 }

 dependencyManagement {
    dependencies {
+        "io.github.robwin:markup-document-builder" "0.1.1"
        "io.swagger:swagger-compat-spec-parser" "1.0.0"
        "commons-collections:commons-collections" "3.2.1"
+        "commons-io:commons-io" "2.4"
        "com.mangofactory:swagger-springmvc" "0.9.5"
        "com.jayway.restassured:spring-mock-mvc" "2.4.0"
+        "ch.qos.logback:logback-classic" "1.1.2"
        "junit:junit" "4.11"
    }
 }

+task sourcesJar(type: Jar, dependsOn: classes) {
+    classifier = 'sources'
+    from sourceSets.main.allSource
+}
+
+task javadocJar(type: Jar, dependsOn: javadoc) {
+    classifier = 'javadoc'
+    from javadoc.destinationDir
+}
+
+artifacts {
+    archives sourcesJar
+    archives javadocJar
+}
+
 asciidoctor {
+    backends = ['html5', 'pdf']
    attributes = [
            doctype: 'book',
            toc: 'left',
-            toclevels: '1'
+            toclevels: '2',
+            numbered: ''
    ]
 }

@@ -78,6 +96,10 @@ tasks.coveralls {
    dependsOn 'check'
 }

+tasks.asciidoctor {
+    dependsOn 'check'
+}
+
 task wrapper(type: Wrapper) {
    gradleVersion = '2.2.1'
-}
+}
--- a/gradle/publishing.gradle
+++ b/gradle/publishing.gradle
@@ -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
+        }
+    }
 }
--- a/images/asciidoc.PNG
+++ b/images/asciidoc.PNG
--- a/images/asciidoc_html.PNG
+++ b/images/asciidoc_html.PNG
--- a/images/asciidoc_pdf.PNG
+++ b/images/asciidoc_pdf.PNG
--- a/images/markdown.PNG
+++ b/images/markdown.PNG
--- a/images/mkdocs_html.PNG
+++ b/images/mkdocs_html.PNG
--- a/src/docs/asciidoc/swagger.adoc
+++ b/src/docs/asciidoc/swagger.adoc
@@ -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
-|===
-
--- a/src/docs/markdown/swagger.md
+++ b/src/docs/markdown/swagger.md
@@ -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|
-
-
--- a/src/main/java/io/github/robwin/swagger2markup/Swagger2MarkupConverter.java
+++ b/src/main/java/io/github/robwin/swagger2markup/Swagger2MarkupConverter.java
@@ -0,0 +1,130 @@
+package io.github.robwin.swagger2markup;
+
+import com.wordnik.swagger.models.Swagger;
+import io.github.robwin.markup.builder.MarkupLanguage;
+import io.github.robwin.swagger2markup.builder.document.DefinitionsDocument;
+import io.github.robwin.swagger2markup.builder.document.PathsDocument;
+import io.swagger.parser.SwaggerParser;
+import org.apache.commons.lang.Validate;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+
+/**
+ * @author Robert Winkler
+ */
+public class Swagger2MarkupConverter {
+    private static final Logger LOG = LoggerFactory.getLogger(Swagger2MarkupConverter.class);
+
+    private final Swagger swagger;
+    private final MarkupLanguage markupLanguage;
+    private final String examplesFolderPath;
+    private final String schemasFolderPath;
+    private static final String PATHS_DOCUMENT = "paths";
+    private static final String DEFINITIONS_DOCUMENT = "definitions";
+
+    /**
+     * @param markupLanguage the markup language which is used to generate the files
+     * @param swagger the Swagger object
+     * @param examplesFolderPath the folderPath where examples are stored
+     * @param schemasFolderPath the folderPath where (XML, JSON)-Schema  files are stored
+     */
+    Swagger2MarkupConverter(MarkupLanguage markupLanguage, Swagger swagger, String examplesFolderPath, String schemasFolderPath){
+        this.markupLanguage = markupLanguage;
+        this.swagger = swagger;
+        this.examplesFolderPath = examplesFolderPath;
+        this.schemasFolderPath = schemasFolderPath;
+    }
+
+    /**
+     * Creates a Swagger2MarkupConverter.Builder using a given Swagger source.
+     *
+     * @param swaggerSource the Swagger source. Can be a HTTP url or a path to a local file.
+     * @return a Swagger2MarkupConverter
+     */
+    public static Builder from(String swaggerSource){
+        Validate.notEmpty(swaggerSource, "swaggerSource must not be null!");
+        return new Builder(swaggerSource);
+    }
+
+    /**
+     * 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);
+    }
+
+    /**
+     * Writes a file for the Paths (API) and a file for the Definitions (Model)
+
+     * @param directory the directory where the generated file should be stored
+     * @throws IOException if a file cannot be written
+     */
+    private void buildDocuments(String directory) throws IOException {
+        new PathsDocument(swagger, markupLanguage, examplesFolderPath).build().writeToFile(directory, PATHS_DOCUMENT, StandardCharsets.UTF_8);
+        new DefinitionsDocument(swagger, markupLanguage, schemasFolderPath).build().writeToFile(directory, DEFINITIONS_DOCUMENT, StandardCharsets.UTF_8);
+    }
+
+
+    public static class Builder{
+        private final Swagger swagger;
+        private String examplesFolderPath;
+        private String schemasFolderPath;
+        private MarkupLanguage markupLanguage = MarkupLanguage.ASCIIDOC;
+
+        /**
+         * Creates a Builder using a given Swagger source.
+         *
+         * @param swaggerSource the Swagger source. Can be a HTTP url or a path to a local file.
+         */
+        Builder(String swaggerSource){
+            swagger = new SwaggerParser().read(swaggerSource);
+        }
+
+        public Swagger2MarkupConverter build(){
+            return new Swagger2MarkupConverter(markupLanguage, swagger, examplesFolderPath, schemasFolderPath);
+        }
+
+        /**
+         * Specifies the markup language which should be used to generate the files
+         *
+         * @param markupLanguage the markup language which is used to generate the files
+         * @return the Swagger2MarkupConverter.Builder
+         */
+        public Builder withMarkupLanguage(MarkupLanguage markupLanguage){
+            this.markupLanguage = markupLanguage;
+            return this;
+        }
+
+        /**
+         * Include examples into the Paths document
+         *
+         * @param examplesFolderPath the path to the folder where the example documents reside
+         * @return the Swagger2MarkupConverter.Builder
+         */
+        public Builder withExamples(String examplesFolderPath){
+            this.examplesFolderPath = examplesFolderPath;
+            return this;
+        }
+
+        /**
+         * Include (JSON, XML) schemas into the Definitions document
+         *
+         * @param schemasFolderPath the path to the folder where the schema documents reside
+         * @return the Swagger2MarkupConverter.Builder
+         */
+        public Builder withSchemas(String schemasFolderPath){
+            this.schemasFolderPath = schemasFolderPath;
+            return this;
+        }
+
+    }
+
+}
--- a/src/main/java/io/github/robwin/swagger2markup/builder/document/DefinitionsDocument.java
+++ b/src/main/java/io/github/robwin/swagger2markup/builder/document/DefinitionsDocument.java
@@ -0,0 +1,140 @@
+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.Property;
+import io.github.robwin.markup.builder.MarkupLanguage;
+import org.apache.commons.collections.MapUtils;
+import org.apache.commons.io.FileUtils;
+import org.apache.commons.lang.StringUtils;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * @author Robert Winkler
+ */
+public class DefinitionsDocument extends MarkupDocument {
+
+    private static final String DEFINITIONS = "Definitions";
+    private static final List<String> IGNORED_DEFINITIONS = Arrays.asList("Void");
+    private static final String JSON_SCHEMA = "JSON Schema";
+    private static final String XML_SCHEMA = "XML Schema";
+    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";
+    public static final String XML = "xml";
+    private boolean schemasEnabled;
+    private String schemasFolderPath;    
+
+    public DefinitionsDocument(Swagger swagger, MarkupLanguage markupLanguage, String schemasFolderPath){
+        super(swagger, markupLanguage);
+        if(StringUtils.isNotBlank(schemasFolderPath)){
+            this.schemasEnabled = true;
+            this.schemasFolderPath = schemasFolderPath;
+        }
+        if(schemasEnabled){
+            if (logger.isDebugEnabled()) {
+                logger.debug("Include schemas is enabled.");
+            }
+        }else{
+            if (logger.isDebugEnabled()) {
+                logger.debug("Include schemas is disabled.");
+            }
+        }
+    }
+
+    @Override
+    public MarkupDocument build() throws IOException {
+        definitions(swagger.getDefinitions());
+        return this;
+    }
+
+    /**
+     * Builds the Swagger definitions.
+     *
+     * @param definitions the Swagger definitions
+     */
+    private void definitions(Map<String, Model> definitions) throws IOException {
+        if(MapUtils.isNotEmpty(definitions)){
+            this.markupDocBuilder.sectionTitleLevel1(DEFINITIONS);
+            for(Map.Entry<String, Model> definitionsEntry : definitions.entrySet()){
+                String definitionName = definitionsEntry.getKey();
+                if(StringUtils.isNotBlank(definitionName)) {
+                    if (checkThatDefinitionIsNotInIgnoreList(definitionName)) {
+                        definition(definitionName, definitionsEntry.getValue());
+                        definitionSchema(definitionName);
+                        if (logger.isInfoEnabled()) {
+                            logger.info("Definition processed: {}", definitionName);
+                        }
+                    }else{
+                        if (logger.isDebugEnabled()) {
+                            logger.debug("Definition was ignored: {}", definitionName);
+                        }
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * Checks that the definition is not in the list of ignored definitions.
+     *
+     * @param definitionName the name of the definition
+     * @return true if the definition can be processed
+     */
+    private boolean checkThatDefinitionIsNotInIgnoreList(String definitionName) {
+        return !IGNORED_DEFINITIONS.contains(definitionName);
+    }
+
+    /**
+     * Builds a concrete definition
+     *
+     * @param definitionName the name of the definition
+     * @param model the Swagger Model of the definition
+     */
+    private void definition(String definitionName, Model model) {
+        this.markupDocBuilder.sectionTitleLevel2(definitionName);
+        Map<String, Property> properties = model.getProperties();
+        List<String> 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());
+        }
+        this.markupDocBuilder.tableWithHeaderRow(csvContent);
+    }
+
+    private void definitionSchema(String definitionName) throws IOException {
+        if(schemasEnabled) {
+            if (StringUtils.isNotBlank(definitionName)) {
+                schema(JSON_SCHEMA, schemasFolderPath, definitionName + JSON_SCHEMA_EXTENSION, JSON);
+                schema(XML_SCHEMA, schemasFolderPath, definitionName + XML_SCHEMA_EXTENSION, XML);
+            }
+        }
+    }
+
+    private void schema(String title, String schemasFolderPath, String schemaName, String language) throws IOException {
+        java.nio.file.Path path = Paths.get(schemasFolderPath, schemaName);
+        if (Files.isReadable(path)) {
+            this.markupDocBuilder.sectionTitleLevel3(title);
+            this.markupDocBuilder.source(FileUtils.readFileToString(path.toFile(), StandardCharsets.UTF_8).trim(), language);
+            if (logger.isInfoEnabled()) {
+                logger.info("Schema file processed: {}", path);
+            }
+        } else {
+            if (logger.isDebugEnabled()) {
+                logger.debug("Schema file is not readable: {}", path);
+            }
+        }
+
+    }
+}
--- a/src/main/java/io/github/robwin/swagger2markup/builder/document/MarkupDocument.java
+++ b/src/main/java/io/github/robwin/swagger2markup/builder/document/MarkupDocument.java
@@ -0,0 +1,57 @@
+package io.github.robwin.swagger2markup.builder.document;
+
+import com.wordnik.swagger.models.Swagger;
+import io.github.robwin.markup.builder.MarkupDocBuilder;
+import io.github.robwin.markup.builder.MarkupDocBuilders;
+import io.github.robwin.markup.builder.MarkupLanguage;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+import java.nio.charset.Charset;
+
+/**
+ * @author Robert Winkler
+ */
+public abstract class MarkupDocument {
+
+    protected static final String DELIMITER = ",";
+    protected static final String REQUIRED_COLUMN = "Required";
+    protected 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);
+    }
+}
--- a/src/main/java/io/github/robwin/swagger2markup/builder/document/PathsDocument.java
+++ b/src/main/java/io/github/robwin/swagger2markup/builder/document/PathsDocument.java
@@ -0,0 +1,229 @@
+package io.github.robwin.swagger2markup.builder.document;
+
+import com.wordnik.swagger.models.*;
+import com.wordnik.swagger.models.parameters.Parameter;
+import io.github.robwin.markup.builder.MarkupLanguage;
+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 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.List;
+import java.util.Map;
+
+/**
+ * @author Robert Winkler
+ */
+public class PathsDocument extends MarkupDocument {
+
+    private static final String VERSION = "Version: ";
+    private static final String DESCRIPTION_COLUMN = "Description";
+    private static final String DESCRIPTION = DESCRIPTION_COLUMN;
+    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 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 boolean examplesEnabled;
+    private String examplesFolderPath;
+
+    public PathsDocument(Swagger swagger, MarkupLanguage markupLanguage, String examplesFolderPath){
+        super(swagger, markupLanguage);
+        if(StringUtils.isNotBlank(examplesFolderPath)){
+            this.examplesEnabled = true;
+            this.examplesFolderPath = examplesFolderPath;
+        }
+        if(examplesEnabled){
+            if (logger.isDebugEnabled()) {
+                logger.debug("Include examples is enabled.");
+            }
+        }else{
+            if (logger.isDebugEnabled()) {
+                logger.debug("Include examples is disabled.");
+            }
+        }
+    }
+
+    @Override
+    public MarkupDocument build() throws IOException {
+        documentHeader(swagger.getInfo());
+        paths(swagger.getPaths());
+        return this;
+    }
+
+    /**
+     * Builds the document header
+     *
+     * @param info the Swagger Info
+     */
+    private void documentHeader(Info info) {
+        this.markupDocBuilder
+                .documentTitle(info.getTitle())
+                .textLine(info.getDescription())
+                .textLine(VERSION + info.getVersion())
+                .newLine();
+    }
+
+    /**
+     * Builds all paths of the Swagger file
+     *
+     * @param paths a Map of Swagger Paths
+     */
+    private void paths(Map<String, Path> paths) throws IOException {
+        if(MapUtils.isNotEmpty(paths)) {
+            //this.documentBuilder.sectionTitleLevel1(FEATURES);
+            for (Map.Entry<String, Path> entry : paths.entrySet()) {
+                Path path = entry.getValue();
+                path("GET", entry.getKey(), path.getGet());
+                path("PUT", entry.getKey(), path.getPut());
+                path("DELETE", entry.getKey(), path.getDelete());
+                path("POST", entry.getKey(), path.getPost());
+                path("PATCH", entry.getKey(), path.getPatch());
+            }
+        }
+    }
+
+    /**
+     * Builds a path
+     *
+     * @param httpMethod the HTTP method of the path
+     * @param resourcePath the URL of the path
+     * @param operation the Swagger Operation
+     */
+    private void path(String httpMethod, String resourcePath, Operation operation) throws IOException {
+        if(operation != null){
+            pathTitle(httpMethod, resourcePath, operation);
+            descriptionSection(operation);
+            parametersSection(operation);
+            responsesSection(operation);
+            consumesSection(operation);
+            producesSection(operation);
+            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.sectionTitleLevel1(title);
+            this.markupDocBuilder.listing(httpMethod + " " + resourcePath);
+        }else{
+            title = httpMethod + " " + resourcePath;
+            this.markupDocBuilder.sectionTitleLevel1(title);
+        }
+        if (logger.isInfoEnabled()) {
+            logger.info("Path processed: {}", title);
+        }
+    }
+
+    private void descriptionSection(Operation operation) {
+        String description = operation.getDescription();
+        if(StringUtils.isNotBlank(description)){
+            this.markupDocBuilder.sectionTitleLevel2(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);
+            for(Parameter parameter : parameters){
+                csvContent.add(parameter.getName() + DELIMITER + parameter.getIn() + DELIMITER + parameter.getDescription() + DELIMITER + parameter.getRequired());
+            }
+            this.markupDocBuilder.sectionTitleLevel2(PARAMETERS);
+            this.markupDocBuilder.tableWithHeaderRow(csvContent);
+        }
+    }
+
+    private void consumesSection(Operation operation) {
+        List<String> consumes = operation.getConsumes();
+        if(CollectionUtils.isNotEmpty(consumes)){
+            this.markupDocBuilder.sectionTitleLevel2(CONSUMES);
+            this.markupDocBuilder.unorderedList(consumes);
+        }
+
+    }
+
+    private void producesSection(Operation operation) {
+        List<String> produces = operation.getProduces();
+        if(CollectionUtils.isNotEmpty(produces)){
+            this.markupDocBuilder.sectionTitleLevel2(PRODUCES);
+            this.markupDocBuilder.unorderedList(produces);
+        }
+    }
+
+    /**
+     * Builds the example section of a Swagger Operation
+     *
+     * @param operation the Swagger Operation
+     * @throws IOException if the example file is not readable
+     */
+    private void examplesSection(Operation operation) throws IOException {
+        if(examplesEnabled){
+            String summary = operation.getSummary();
+            if(StringUtils.isNotBlank(summary)) {
+                String exampleFolder = summary.replace(".", "").replace(" ", "_").toLowerCase();
+                example(EXAMPLE_REQUEST, exampleFolder, REQUEST_EXAMPLE_FILE_NAME);
+                example(EXAMPLE_RESPONSE, exampleFolder, RESPONSE_EXAMPLE_FILE_NAME);
+            }
+        }
+    }
+
+    /**
+     * Builds a concrete example
+     *
+     * @param title the title of the example
+     * @param exampleFolder the name of the folder where the example file resides
+     * @param exampleFileName the name of the example file
+     * @throws IOException
+     */
+    private void example(String title, String exampleFolder, String exampleFileName) throws IOException {
+        for (String fileNameExtension : markupLanguage.getFileNameExtensions()) {
+            java.nio.file.Path path = Paths.get(examplesFolderPath, exampleFolder, exampleFileName + fileNameExtension);
+            if (Files.isReadable(path)) {
+                this.markupDocBuilder.sectionTitleLevel2(title);
+                this.markupDocBuilder.paragraph(FileUtils.readFileToString(path.toFile(), StandardCharsets.UTF_8).trim());
+                if (logger.isInfoEnabled()) {
+                    logger.info("Example file processed: {}", path);
+                }
+                break;
+            } else {
+                if (logger.isDebugEnabled()) {
+                    logger.debug("Example file is not readable: {}", path);
+                }
+            }
+        }
+    }
+
+    private void responsesSection(Operation operation) {
+        Map<String, Response> responses = operation.getResponses();
+        if(MapUtils.isNotEmpty(responses)){
+            List<String> csvContent = new ArrayList<>();
+            csvContent.add(CODE_COLUMN + DELIMITER + DESCRIPTION_COLUMN);
+            for(Map.Entry<String, Response> entry : responses.entrySet()){
+                Response response = entry.getValue();
+                csvContent.add(entry.getKey() + DELIMITER + response.getDescription());
+            }
+            this.markupDocBuilder.sectionTitleLevel2(RESPONSES);
+            this.markupDocBuilder.tableWithHeaderRow(csvContent);
+        }
+    }
+
+}
--- a/src/main/java/io/swagger2markup/Swagger2MarkupConverter.java
+++ b/src/main/java/io/swagger2markup/Swagger2MarkupConverter.java
@@ -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);
-                }
-            }
-        }
-    }
-
-}
--- a/src/main/java/io/swagger2markup/builder/AbstractDocumentBuilder.java
+++ b/src/main/java/io/swagger2markup/builder/AbstractDocumentBuilder.java
@@ -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();
-    }
-}
--- a/src/main/java/io/swagger2markup/builder/DocumentBuilder.java
+++ b/src/main/java/io/swagger2markup/builder/DocumentBuilder.java
@@ -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();
-}
--- a/src/main/java/io/swagger2markup/builder/Markup.java
+++ b/src/main/java/io/swagger2markup/builder/Markup.java
@@ -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();
-}
--- a/src/main/java/io/swagger2markup/builder/asciidoc/AsciiDoc.java
+++ b/src/main/java/io/swagger2markup/builder/asciidoc/AsciiDoc.java
@@ -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;
-    }
-}
--- a/src/main/java/io/swagger2markup/builder/asciidoc/AsciiDocBuilder.java
+++ b/src/main/java/io/swagger2markup/builder/asciidoc/AsciiDocBuilder.java
@@ -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;
-    }
-}
--- a/src/main/java/io/swagger2markup/builder/markdown/Markdown.java
+++ b/src/main/java/io/swagger2markup/builder/markdown/Markdown.java
@@ -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;
-    }
-}
--- a/src/main/java/io/swagger2markup/builder/markdown/MarkdownBuilder.java
+++ b/src/main/java/io/swagger2markup/builder/markdown/MarkdownBuilder.java
@@ -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;
-    }
-}
--- a/src/main/resources/logback.xml
+++ b/src/main/resources/logback.xml
@@ -0,0 +1,12 @@
+<?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>
--- a/src/test/java/io/github/robwin/swagger2markup/Swagger2MarkupConverterTest.java
+++ b/src/test/java/io/github/robwin/swagger2markup/Swagger2MarkupConverterTest.java
@@ -0,0 +1,28 @@
+package io.github.robwin.swagger2markup;
+
+import io.github.robwin.markup.builder.MarkupLanguage;
+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()).
+                withMarkupLanguage(MarkupLanguage.MARKDOWN).
+                withExamples("docs").withSchemas("docs/schemas").build()
+                .intoFolder("src/docs/markdown");
+
+        Swagger2MarkupConverter.from(file.getAbsolutePath()).
+                withExamples("docs").withSchemas("docs/schemas").build()
+                .intoFolder("src/docs/asciidoc");
+
+    }
+}
--- a/src/test/java/io/swagger2markup/Swagger2MarkupConverterTest.java
+++ b/src/test/java/io/swagger2markup/Swagger2MarkupConverterTest.java
@@ -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");
-    }
-}
Author	SHA1	Message	Date
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