Compare commits
36 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
8d4bc8c0bc | ||
|
76df322bb4 | ||
|
|
36cdd3cebb | ||
|
|
ca4587cb29 | ||
|
|
ce958ba798 | ||
|
|
7c5c0fea8c | ||
|
|
5bc557a5d2 | ||
|
|
e23a649c17 | ||
|
|
a5300ceab5 | ||
|
|
fdb405e52a | ||
|
|
79cdd26ef0 | ||
|
|
87c24c8f31 | ||
|
|
6216165515 | ||
|
|
77640d21be | ||
|
|
57282f4933 | ||
|
|
1a12e0dc11 | ||
|
|
2b0317d1f6 | ||
|
|
8fce706f31 | ||
|
|
ae0f3ab31d | ||
|
|
34cb438757 | ||
|
|
8747ba2c1d | ||
|
|
bef4e3c735 | ||
|
|
6396b8fdb7 | ||
|
|
e27ba4304d | ||
|
|
4c86e73c4e | ||
|
|
9f9fa8c444 | ||
|
|
9647116572 | ||
|
|
736891fbdd | ||
|
|
acec733af7 | ||
|
|
73cdc35c80 | ||
|
|
cae91b3565 | ||
|
|
ec610f4fbb | ||
|
|
edf9ba01bd | ||
|
|
e942252d9a | ||
|
|
04d1773c03 | ||
|
|
448899c193 |
173
README.adoc
173
README.adoc
@@ -1,16 +1,22 @@
|
||||
= Swagger2Markup
|
||||
:author: Robert Winkler
|
||||
:version: 0.2.1
|
||||
:version: 0.4.0
|
||||
:hardbreaks:
|
||||
|
||||
image:https://travis-ci.org/RobWin/swagger2markup.svg["Build Status", link="https://travis-ci.org/RobWin/swagger2markup"] image:https://coveralls.io/repos/RobWin/swagger2markup/badge.svg["Coverage Status", link="https://coveralls.io/r/RobWin/swagger2markup"] image:https://api.bintray.com/packages/robwin/maven/swagger2markup/images/download.svg[link="https://bintray.com/robwin/maven/swagger2markup/_latestVersion"] image:http://img.shields.io/badge/license-ASF2-blue.svg["Apache License 2", link="http://www.apache.org/licenses/LICENSE-2.0.txt"]
|
||||
image:https://badges.gitter.im/Join%20Chat.svg[link="https://gitter.im/RobWin/swagger2markup?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"]
|
||||
|
||||
== Overview
|
||||
|
||||
This project is a Swagger to Markup (AsciiDoc and Markdown) converter. The *Swagger2MarkupConverter* takes a swagger.json or swagger.yaml file as source and converts it into an AsciiDoc or Markdown document. The Swagger source file can be located locally or remotely accessible via HTTP. The Swagger2MarkupConverter supports the Swagger 1.2 and 2.0 specification. Internally it uses the _official_ https://github.com/swagger-api/swagger-parser[swagger-parser] and my https://github.com/RobWin/markup-document-builder[markup-document-builder].
|
||||
The primary goal of this project is to simplify the documentation of a RESTful API by combining documentation that's been hand-written with auto-generated API documentation produced by https://github.com/swagger-api[Swagger]. The result is intended to be an easy-to-read, on- and offline user guide, comparable to https://developer.github.com/v3/[GitHub's API documentation].
|
||||
|
||||
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>>.
|
||||
This project is a Swagger to Markup (AsciiDoc and GitHub Flavored Markdown) converter. The *Swagger2MarkupConverter* takes a swagger.json or swagger.yaml file as source and converts it into three documents (Overview, Paths and Definitions) which can be combined with hand-written documentation. The Swagger source file can be located locally or remotely 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].
|
||||
|
||||
http://asciidoctor.org/docs/asciidoc-writers-guide/[AsciiDoc] is a text document format for writing documentation, articles, books, ebooks, slideshows, web pages and blogs. AsciiDoc files can be converted to many formats including HTML, PDF and EPUB. You write an AsciiDoc document the same way you would write a normal text document.
|
||||
|
||||
You can use Swagger2Markup to convert your design-first Swagger YAML file into a human-readable format and combine it with hand-written documentation. As an alternative, you can choose the implementation-first approach and use Swagger2Markup together with https://github.com/swagger-api/swagger-core/tree/master/samples/java-jersey2[Swagger JAX-RS], https://github.com/springfox/springfox[springfox] or https://github.com/spring-projects/spring-restdocs[spring-restdocs]. See usage guide below and <<integration-with-spring-restdocs, Integration with spring-restdocs>>.
|
||||
|
||||
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/jbake-org/jbake[JBake], https://github.com/tomchristie/mkdocs[MkDocs], https://github.com/rtfd/readthedocs.org[ReadTheDocs] or https://github.com/tripit/slate[slate] to publish your AsciiDoc or Markdown documentation.
|
||||
|
||||
The project requires at least JDK 7.
|
||||
|
||||
@@ -37,7 +43,7 @@ The project is published in JCenter and Maven Central.
|
||||
<dependency>
|
||||
<groupId>io.github.robwin</groupId>
|
||||
<artifactId>swagger2markup</artifactId>
|
||||
<version>0.2.1</version>
|
||||
<version>0.4.0</version>
|
||||
</dependency>
|
||||
----
|
||||
|
||||
@@ -49,35 +55,45 @@ repositories {
|
||||
jcenter()
|
||||
}
|
||||
|
||||
compile "io.github.robwin:swagger2markup:0.2.1"
|
||||
compile "io.github.robwin:swagger2markup:0.4.0"
|
||||
----
|
||||
|
||||
=== 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].
|
||||
Using the Swagger2MarkupConverter is simple. For example, you can generate your AsciiDoc or Markdown documentation using https://github.com/spring-projects/spring-boot[Spring Boot] and https://github.com/springfox/springfox[springfox] during the unit or integration test phase, copy the documentation into the Jar file and serve it as static content.
|
||||
The quickest way to get started is to look at the demo project https://github.com/RobWin/spring-swagger2markup-demo[spring-swagger2markup-demo]. The demo shows how to generate static docs (HTML5 and PDF) with Swagger2Markup and serve them as static content in a Spring Boot App under http://localhost:9080/docs/index.html and http://localhost:9080/docs/index.pdf.
|
||||
|
||||
==== Integration Test
|
||||
|
||||
Swagger2MarkupConverter can be used to make a request to a Swagger endpoint during an integration test. The Swagger2MarkupConverter writes the documents into the folder "src/docs/asciidoc".
|
||||
|
||||
[source,java]
|
||||
----
|
||||
@RunWith(SpringJUnit4ClassRunner.class)
|
||||
@SpringApplicationConfiguration(classes = SpringBootSwaggerConfig.class)
|
||||
@SpringApplicationConfiguration(classes = Application.class)
|
||||
@IntegrationTest
|
||||
@WebAppConfiguration
|
||||
public class Swagger2MarkupTest {
|
||||
|
||||
@Test
|
||||
public void convertSwaggerToMarkup() {
|
||||
//Remote Swagger source
|
||||
//Markdown
|
||||
Swagger2MarkupConverter.from("http://localhost:8080/api-docs").
|
||||
withMarkupLanguage(MarkupLanguage.MARKDOWN).build()
|
||||
.intoFolder("src/docs/markdown");
|
||||
|
||||
public void convertRemoteSwaggerToAsciiDoc() {
|
||||
//Remote Swagger source
|
||||
//Default is AsciiDoc
|
||||
Swagger2MarkupConverter.from("http://localhost:8080/api-docs").build()
|
||||
Swagger2MarkupConverter.from("http://localhost:8080/v2/api-docs").build()
|
||||
.intoFolder("src/docs/asciidoc");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void convertRemoteSwaggerToMarkdown() {
|
||||
//Remote Swagger source
|
||||
//Markdown
|
||||
Swagger2MarkupConverter.from("http://localhost:8080/v2/api-docs").
|
||||
withMarkupLanguage(MarkupLanguage.MARKDOWN).build()
|
||||
.intoFolder("src/docs/markdown");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void convertLocalSwaggerToAsciiDoc() {
|
||||
//Local Swagger source
|
||||
//Default is AsciiDoc
|
||||
File file = new File(Swagger2MarkupTest.class.getResource("/json/swagger.json").getFile());
|
||||
@@ -87,42 +103,112 @@ public class Swagger2MarkupTest {
|
||||
}
|
||||
----
|
||||
|
||||
==== Unit Test
|
||||
|
||||
Spring's MVC Test framework can also be used to make a request to a https://github.com/springfox/springfox[springfox] Swagger endpoint during an unit test. A custom ResultHandler is used to automatically convert the Swagger JSON response into an AsciiDoc document.
|
||||
That way you verify that your Swagger endpoint is working, too. The test cycle is much faster then.
|
||||
|
||||
[source,java]
|
||||
----
|
||||
@SpringBootApplication
|
||||
@EnableSwagger
|
||||
public class SpringBootSwaggerConfig {
|
||||
|
||||
public static void main(String[] args) {
|
||||
SpringApplication.run(SpringBootTestConfig.class, args);
|
||||
}
|
||||
@WebAppConfiguration
|
||||
@RunWith(SpringJUnit4ClassRunner.class)
|
||||
@ContextConfiguration(classes = Application.class, loader = SpringApplicationContextLoader.class)
|
||||
public class Swagger2MarkupTest {
|
||||
|
||||
@Autowired
|
||||
private SpringSwaggerConfig springSwaggerConfig;
|
||||
private WebApplicationContext context;
|
||||
|
||||
@Bean
|
||||
public SwaggerSpringMvcPlugin customImplementation(){
|
||||
return new SwaggerSpringMvcPlugin(this.springSwaggerConfig)
|
||||
.apiInfo(apiInfo()).excludeAnnotations(Controller.class);
|
||||
private MockMvc mockMvc;
|
||||
|
||||
@Before
|
||||
public void setUp() {
|
||||
this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context).build();
|
||||
}
|
||||
|
||||
private ApiInfo apiInfo() {
|
||||
ApiInfo apiInfo = new ApiInfo(
|
||||
"My Apps API Title",
|
||||
"My Apps API Description",
|
||||
"My Apps API terms of service",
|
||||
"My Apps API Contact Email",
|
||||
"My Apps API Licence Type",
|
||||
"My Apps API License URL"
|
||||
);
|
||||
return apiInfo;
|
||||
@Test
|
||||
public void convertSwaggerToAsciiDoc() throws Exception {
|
||||
this.mockMvc.perform(get("/v2/api-docs")
|
||||
.accept(MediaType.APPLICATION_JSON))
|
||||
.andDo(Swagger2MarkupDocumentation.document("swagger_adoc"))
|
||||
.andExpect(status().isOk());
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
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]
|
||||
==== Springfox configuration
|
||||
|
||||
The following is a complete https://github.com/springfox/springfox[springfox] configuration to use Swagger in a Spring Boot Application.
|
||||
|
||||
[source,java]
|
||||
----
|
||||
@SpringBootApplication
|
||||
@EnableSwagger2
|
||||
public class Application {
|
||||
|
||||
public static void main(String[] args) {
|
||||
SpringApplication.run(Application.class, args);
|
||||
}
|
||||
|
||||
@Bean
|
||||
public Docket restApi() {
|
||||
return new Docket(DocumentationType.SWAGGER_2)
|
||||
.apiInfo(apiInfo())
|
||||
.select()
|
||||
.paths(ant("/api/**"))
|
||||
.build();
|
||||
}
|
||||
|
||||
private ApiInfo apiInfo() {
|
||||
return new ApiInfoBuilder()
|
||||
.title("Petstore API Title")
|
||||
.description("Petstore API Description")
|
||||
.contact("Petstore API Contact Email")
|
||||
.version("1.0.0")
|
||||
.build();
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
==== Combine generated documentation with your hand-written documentation
|
||||
|
||||
The following shows how you can combine the generated documentation with your hand-written documentation with AsciiDoc.
|
||||
|
||||
image::images/generated_docs.PNG[generated_docs]
|
||||
|
||||
You can generate your HTML5 and PDF documentation via the https://github.com/asciidoctor/asciidoctor-gradle-plugin[asciidoctor-gradle-plugin]. The following shows how to configure the asciidoctor-gradle-plugin. By default it searches for AsciiDoc files in "src/docs/asciidoc" and puts the HTML and PDF output into "build/asciidoc/html5" and "build/asciidoc/pdf".
|
||||
|
||||
[source]
|
||||
----
|
||||
asciidoctor {
|
||||
sources {
|
||||
include 'index.adoc'
|
||||
}
|
||||
backends = ['html5', 'pdf']
|
||||
attributes = [
|
||||
doctype: 'book',
|
||||
toc: 'left',
|
||||
toclevels: '2',
|
||||
numbered: '',
|
||||
sectlinks: '',
|
||||
sectanchors: ''
|
||||
]
|
||||
}
|
||||
----
|
||||
|
||||
You can copy the output into your Jar file and serve the documentation as static content.
|
||||
|
||||
[source]
|
||||
----
|
||||
jar {
|
||||
dependsOn asciidoctor
|
||||
from ("${asciidoctor.outputDir}/html5") {
|
||||
into 'static/docs'
|
||||
}
|
||||
from ("${asciidoctor.outputDir}/pdf") {
|
||||
into 'static/docs'
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
== Examples
|
||||
== Swagger source file
|
||||
@@ -137,9 +223,6 @@ image::images/markdown.PNG[markdown]
|
||||
=== Generated HTML using AsciidoctorJ
|
||||
image::images/asciidoc_html.PNG[asciidoc_html]
|
||||
|
||||
=== Generated HTML using Mkdocs
|
||||
image::images/mkdocs_html.PNG[mkdocs_html]
|
||||
|
||||
=== Generated PDF using AsciidoctorJ
|
||||
image::images/asciidoc_pdf.PNG[asciidoc_pdf]
|
||||
|
||||
|
||||
@@ -7,4 +7,24 @@
|
||||
* 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
|
||||
* Signed jar files and published in Maven Central
|
||||
|
||||
=== Version 0.2.2
|
||||
* Fixed wrong dependency version to io.github.robwin:markup-document-builder
|
||||
|
||||
=== Version 0.2.3
|
||||
* Fixed issue #7: @ApiModelProperty metadata are ignored for definitions file
|
||||
|
||||
=== Version 0.2.4
|
||||
* Fixed issue #8: logback.xml on the classpath
|
||||
* Fixed issue #13: unknown format not supported for properties
|
||||
|
||||
== Version 0.3.0
|
||||
* Support of YAML or JSON String as input.
|
||||
|
||||
== Version 0.4.0
|
||||
* Updated Swagger-Parser from 1.0.0 to 1.0.5
|
||||
* Updated commons-lang to commons-lang3
|
||||
* Swagger2MarkupConverter generates three documents now: overview, paths and definitions
|
||||
* Support for enums in HeaderParameter, QueryParameter, FormParameter and QueryParameter
|
||||
* Support for global consumes, produces and tags
|
||||
32
build.gradle
32
build.gradle
@@ -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.4.0.RELEASE'
|
||||
classpath 'io.spring.gradle:dependency-management-plugin:0.5.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.2'
|
||||
version = '0.4.0'
|
||||
group = 'io.github.robwin'
|
||||
|
||||
apply plugin: 'java'
|
||||
@@ -36,6 +36,7 @@ tasks.withType(JavaCompile) {
|
||||
repositories {
|
||||
jcenter()
|
||||
mavenCentral()
|
||||
mavenLocal()
|
||||
}
|
||||
|
||||
dependencies {
|
||||
@@ -43,20 +44,22 @@ dependencies {
|
||||
compile 'io.swagger:swagger-compat-spec-parser'
|
||||
compile 'commons-collections:commons-collections'
|
||||
compile 'commons-io:commons-io'
|
||||
compile 'ch.qos.logback:logback-classic'
|
||||
compile 'org.slf4j:slf4j-api'
|
||||
testCompile 'junit:junit'
|
||||
testCompile 'org.asciidoctor:asciidoctorj:1.5.2'
|
||||
testCompile 'org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.6'
|
||||
testCompile 'ch.qos.logback:logback-classic'
|
||||
}
|
||||
|
||||
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"
|
||||
dependency "io.github.robwin:markup-document-builder:0.1.3"
|
||||
dependency "io.swagger:swagger-compat-spec-parser:1.0.5"
|
||||
dependency "commons-collections:commons-collections:3.2.1"
|
||||
dependency "commons-io:commons-io:2.4"
|
||||
dependency "junit:junit:4.11"
|
||||
dependency "org.slf4j:slf4j-api:1.7.12"
|
||||
dependency "ch.qos.logback:logback-classic:1.1.2"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -76,12 +79,17 @@ artifacts {
|
||||
}
|
||||
|
||||
asciidoctor {
|
||||
sources {
|
||||
include 'index.adoc'
|
||||
}
|
||||
backends = ['html5', 'pdf']
|
||||
attributes = [
|
||||
doctype: 'book',
|
||||
toc: 'left',
|
||||
toclevels: '2',
|
||||
numbered: ''
|
||||
numbered: '',
|
||||
sectlinks: '',
|
||||
sectanchors: ''
|
||||
]
|
||||
}
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 44 KiB |
BIN
images/asciidoc2_html.PNG
Normal file
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: 109 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 153 KiB After Width: | Height: | Size: 138 KiB |
BIN
images/generated_docs.PNG
Normal file
BIN
images/generated_docs.PNG
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 22 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 29 KiB |
55
src/docs/asciidoc/generated/definitions.adoc
Normal file
55
src/docs/asciidoc/generated/definitions.adoc
Normal 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
|
||||
|===
|
||||
|
||||
27
src/docs/asciidoc/generated/overview.adoc
Normal file
27
src/docs/asciidoc/generated/overview.adoc
Normal file
@@ -0,0 +1,27 @@
|
||||
= Swagger Petstore API
|
||||
|
||||
== Overview
|
||||
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 information
|
||||
Version: 1.0.0
|
||||
|
||||
=== Contact information
|
||||
Contact: apiteam@wordnik.com
|
||||
|
||||
=== License information
|
||||
License: Apache 2.0
|
||||
License URL: http://www.apache.org/licenses/LICENSE-2.0.html
|
||||
|
||||
Terms of service: http://helloreverb.com/terms/
|
||||
|
||||
=== URI scheme
|
||||
Host: petstore.swagger.wordnik.com
|
||||
BasePath: /v2
|
||||
Schemes: HTTP
|
||||
|
||||
564
src/docs/asciidoc/generated/paths.adoc
Normal file
564
src/docs/asciidoc/generated/paths.adoc
Normal file
@@ -0,0 +1,564 @@
|
||||
== 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
|
||||
|
||||
13
src/docs/asciidoc/index.adoc
Normal file
13
src/docs/asciidoc/index.adoc
Normal file
@@ -0,0 +1,13 @@
|
||||
:doctype: book
|
||||
:toc: left
|
||||
:toclevels: 2
|
||||
:numbered:
|
||||
:sectlinks:
|
||||
:sectanchors:
|
||||
:hardbreaks:
|
||||
|
||||
include::generated/overview.adoc[]
|
||||
include::manual_content1.adoc[]
|
||||
include::manual_content2.adoc[]
|
||||
include::generated/paths.adoc[]
|
||||
include::generated/definitions.adoc[]
|
||||
9
src/docs/asciidoc/manual_content1.adoc
Normal file
9
src/docs/asciidoc/manual_content1.adoc
Normal file
@@ -0,0 +1,9 @@
|
||||
== Chapter of manual content 1
|
||||
|
||||
This is some dummy text
|
||||
|
||||
=== Sub chapter
|
||||
|
||||
Dummy text of sub chapter
|
||||
|
||||
|
||||
4
src/docs/asciidoc/manual_content2.adoc
Normal file
4
src/docs/asciidoc/manual_content2.adoc
Normal file
@@ -0,0 +1,4 @@
|
||||
== Chapter of manual content 2
|
||||
|
||||
This is some dummy text
|
||||
|
||||
1554
src/docs/generated/asciidocAsString/spica.adoc
Normal file
1554
src/docs/generated/asciidocAsString/spica.adoc
Normal file
File diff suppressed because it is too large
Load Diff
5698
src/docs/generated/asciidocAsString/spica.html
Normal file
5698
src/docs/generated/asciidocAsString/spica.html
Normal file
File diff suppressed because it is too large
Load Diff
646
src/docs/generated/asciidocAsString/swagger.adoc
Normal file
646
src/docs/generated/asciidocAsString/swagger.adoc
Normal file
@@ -0,0 +1,646 @@
|
||||
= Swagger Petstore API
|
||||
|
||||
== Overview
|
||||
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 information
|
||||
Version: 1.0.0
|
||||
|
||||
=== Contact information
|
||||
Contact: apiteam@wordnik.com
|
||||
|
||||
=== License information
|
||||
License: Apache 2.0
|
||||
License URL: http://www.apache.org/licenses/LICENSE-2.0.html
|
||||
|
||||
Terms of service: http://helloreverb.com/terms/
|
||||
|
||||
=== URI scheme
|
||||
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
|
||||
|===
|
||||
|
||||
2465
src/docs/generated/asciidocAsString/swagger.html
Normal file
2465
src/docs/generated/asciidocAsString/swagger.html
Normal file
File diff suppressed because it is too large
Load Diff
50
src/docs/markdown/generated/definitions.md
Normal file
50
src/docs/markdown/generated/definitions.md
Normal 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|
|
||||
|
||||
|
||||
27
src/docs/markdown/generated/overview.md
Normal file
27
src/docs/markdown/generated/overview.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# Swagger Petstore API
|
||||
|
||||
## Overview
|
||||
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 information
|
||||
Version: 1.0.0
|
||||
|
||||
### Contact information
|
||||
Contact: apiteam@wordnik.com
|
||||
|
||||
### License information
|
||||
License: Apache 2.0
|
||||
License URL: http://www.apache.org/licenses/LICENSE-2.0.html
|
||||
|
||||
Terms of service: http://helloreverb.com/terms/
|
||||
|
||||
### URI scheme
|
||||
Host: petstore.swagger.wordnik.com
|
||||
BasePath: /v2
|
||||
Schemes: HTTP
|
||||
|
||||
529
src/docs/markdown/generated/paths.md
Normal file
529
src/docs/markdown/generated/paths.md
Normal file
@@ -0,0 +1,529 @@
|
||||
## Paths
|
||||
### Update an existing pet
|
||||
```
|
||||
PUT /pets
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|BodyParameter|body|Pet object that needs to be added to the store|false|Pet|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|400|Invalid ID supplied|No Content|
|
||||
|404|Pet not found|No Content|
|
||||
|405|Validation exception|No Content|
|
||||
|
||||
|
||||
### Consumes
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* pet
|
||||
|
||||
### Add a new pet to the store
|
||||
```
|
||||
POST /pets
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|BodyParameter|body|Pet object that needs to be added to the store|false|Pet|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|405|Invalid input|No Content|
|
||||
|
||||
|
||||
### Consumes
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* pet
|
||||
|
||||
### Finds Pets by status
|
||||
```
|
||||
GET /pets/findByStatus
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Multiple status values can be provided with comma seperated strings
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|QueryParameter|status|Status values that need to be considered for filter|false|multi string array|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|200|successful operation|Pet array|
|
||||
|400|Invalid status value|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* pet
|
||||
|
||||
### Finds Pets by tags
|
||||
```
|
||||
GET /pets/findByTags
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|QueryParameter|tags|Tags to filter by|false|multi string array|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|200|successful operation|Pet array|
|
||||
|400|Invalid tag value|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* pet
|
||||
|
||||
### Find pet by ID
|
||||
```
|
||||
GET /pets/{petId}
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|PathParameter|petId|ID of pet that needs to be fetched|true|integer (int64)|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|200|successful operation|Pet|
|
||||
|400|Invalid ID supplied|No Content|
|
||||
|404|Pet not found|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* pet
|
||||
|
||||
### Deletes a pet
|
||||
```
|
||||
DELETE /pets/{petId}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|HeaderParameter|api_key||true|string|
|
||||
|PathParameter|petId|Pet id to delete|true|integer (int64)|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|400|Invalid pet value|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* pet
|
||||
|
||||
### Updates a pet in the store with form data
|
||||
```
|
||||
POST /pets/{petId}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|PathParameter|petId|ID of pet that needs to be updated|true|string|
|
||||
|FormDataParameter|name|Updated name of the pet|true|string|
|
||||
|FormDataParameter|status|Updated status of the pet|true|string|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|405|Invalid input|No Content|
|
||||
|
||||
|
||||
### Consumes
|
||||
|
||||
* application/x-www-form-urlencoded
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* pet
|
||||
|
||||
### Place an order for a pet
|
||||
```
|
||||
POST /stores/order
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|BodyParameter|body|order placed for purchasing the pet|false|Order|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|200|successful operation|Order|
|
||||
|400|Invalid Order|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* store
|
||||
|
||||
### Find purchase order by ID
|
||||
```
|
||||
GET /stores/order/{orderId}
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|PathParameter|orderId|ID of pet that needs to be fetched|true|string|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|200|successful operation|Order|
|
||||
|400|Invalid ID supplied|No Content|
|
||||
|404|Order not found|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* store
|
||||
|
||||
### Delete purchase order by ID
|
||||
```
|
||||
DELETE /stores/order/{orderId}
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|PathParameter|orderId|ID of the order that needs to be deleted|true|string|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|400|Invalid ID supplied|No Content|
|
||||
|404|Order not found|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* store
|
||||
|
||||
### Create user
|
||||
```
|
||||
POST /users
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This can only be done by the logged in user.
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|BodyParameter|body|Created user object|false|User|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|default|successful operation|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* user
|
||||
|
||||
### Creates list of users with given input array
|
||||
```
|
||||
POST /users/createWithArray
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|BodyParameter|body|List of user object|false|User array|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|default|successful operation|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* user
|
||||
|
||||
### Creates list of users with given input array
|
||||
```
|
||||
POST /users/createWithList
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|BodyParameter|body|List of user object|false|User array|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|default|successful operation|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* user
|
||||
|
||||
### Logs user into the system
|
||||
```
|
||||
GET /users/login
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|QueryParameter|username|The user name for login|false|string|
|
||||
|QueryParameter|password|The password for login in clear text|false|string|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|200|successful operation|string|
|
||||
|400|Invalid username/password supplied|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* user
|
||||
|
||||
### Logs out current logged in user session
|
||||
```
|
||||
GET /users/logout
|
||||
```
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|default|successful operation|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* user
|
||||
|
||||
### Get user by user name
|
||||
```
|
||||
GET /users/{username}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|PathParameter|username|The name that needs to be fetched. Use user1 for testing.|true|string|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|200|successful operation|User|
|
||||
|400|Invalid username supplied|No Content|
|
||||
|404|User not found|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* user
|
||||
|
||||
### Updated user
|
||||
```
|
||||
PUT /users/{username}
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This can only be done by the logged in user.
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|PathParameter|username|name that need to be deleted|true|string|
|
||||
|BodyParameter|body|Updated user object|false|User|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|400|Invalid user supplied|No Content|
|
||||
|404|User not found|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* user
|
||||
|
||||
### Delete user
|
||||
```
|
||||
DELETE /users/{username}
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This can only be done by the logged in user.
|
||||
|
||||
### Parameters
|
||||
|Type|Name|Description|Required|Schema|
|
||||
|----|----|----|----|----|
|
||||
|PathParameter|username|The name that needs to be deleted|true|string|
|
||||
|
||||
|
||||
### Responses
|
||||
|HTTP Code|Description|Schema|
|
||||
|----|----|----|
|
||||
|400|Invalid username supplied|No Content|
|
||||
|404|User not found|No Content|
|
||||
|
||||
|
||||
### Produces
|
||||
|
||||
* application/json
|
||||
* application/xml
|
||||
|
||||
### Tags
|
||||
|
||||
* user
|
||||
|
||||
@@ -1,11 +1,16 @@
|
||||
package io.github.robwin.swagger2markup;
|
||||
|
||||
import com.fasterxml.jackson.databind.JsonNode;
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import com.wordnik.swagger.models.Swagger;
|
||||
import com.wordnik.swagger.util.Json;
|
||||
import com.wordnik.swagger.util.Yaml;
|
||||
import io.github.robwin.markup.builder.MarkupLanguage;
|
||||
import io.github.robwin.swagger2markup.builder.document.DefinitionsDocument;
|
||||
import io.github.robwin.swagger2markup.builder.document.OverviewDocument;
|
||||
import io.github.robwin.swagger2markup.builder.document.PathsDocument;
|
||||
import io.swagger.parser.SwaggerParser;
|
||||
import org.apache.commons.lang.Validate;
|
||||
import org.apache.commons.lang3.Validate;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
@@ -22,6 +27,7 @@ public class Swagger2MarkupConverter {
|
||||
private final MarkupLanguage markupLanguage;
|
||||
private final String examplesFolderPath;
|
||||
private final String schemasFolderPath;
|
||||
private static final String OVERVIEW_DOCUMENT = "overview";
|
||||
private static final String PATHS_DOCUMENT = "paths";
|
||||
private static final String DEFINITIONS_DOCUMENT = "definitions";
|
||||
|
||||
@@ -41,12 +47,47 @@ public class Swagger2MarkupConverter {
|
||||
/**
|
||||
* 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.
|
||||
* @param swaggerLocation the Swagger location. Can be a HTTP url or a path to a local file.
|
||||
* @return a Swagger2MarkupConverter
|
||||
*/
|
||||
public static Builder from(String swaggerSource){
|
||||
Validate.notEmpty(swaggerSource, "swaggerSource must not be null!");
|
||||
return new Builder(swaggerSource);
|
||||
public static Builder from(String swaggerLocation){
|
||||
Validate.notEmpty(swaggerLocation, "swaggerLocation must not be empty!");
|
||||
return new Builder(swaggerLocation);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a Swagger2MarkupConverter.Builder from a given Swagger model.
|
||||
*
|
||||
* @param swagger the Swagger source.
|
||||
* @return a Swagger2MarkupConverter
|
||||
*/
|
||||
public static Builder from(Swagger swagger){
|
||||
Validate.notNull(swagger, "swagger must not be null!");
|
||||
return new Builder(swagger);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a Swagger2MarkupConverter.Builder from a given Swagger YAML or JSON String.
|
||||
*
|
||||
* @param swagger the Swagger YAML or JSON String.
|
||||
* @return a Swagger2MarkupConverter
|
||||
*/
|
||||
public static Builder fromString(String swagger) throws IOException {
|
||||
Validate.notEmpty(swagger, "swagger must not be null!");
|
||||
ObjectMapper mapper;
|
||||
if(swagger.trim().startsWith("{")) {
|
||||
mapper = Json.mapper();
|
||||
}else {
|
||||
mapper = Yaml.mapper();
|
||||
}
|
||||
JsonNode rootNode = mapper.readTree(swagger);
|
||||
|
||||
// must have swagger node set
|
||||
JsonNode swaggerNode = rootNode.get("swagger");
|
||||
if(swaggerNode == null)
|
||||
throw new IllegalArgumentException("Swagger String is in the wrong format");
|
||||
|
||||
return new Builder(mapper.convertValue(rootNode, Swagger.class));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -61,6 +102,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)
|
||||
|
||||
@@ -68,10 +118,22 @@ public class Swagger2MarkupConverter {
|
||||
* @throws IOException if a file cannot be written
|
||||
*/
|
||||
private void buildDocuments(String directory) throws IOException {
|
||||
new OverviewDocument(swagger, markupLanguage).build().writeToFile(directory, OVERVIEW_DOCUMENT, StandardCharsets.UTF_8);
|
||||
new PathsDocument(swagger, markupLanguage, examplesFolderPath).build().writeToFile(directory, PATHS_DOCUMENT, StandardCharsets.UTF_8);
|
||||
new DefinitionsDocument(swagger, markupLanguage, schemasFolderPath).build().writeToFile(directory, DEFINITIONS_DOCUMENT, StandardCharsets.UTF_8);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a file for the Paths (API) and a file for the Definitions (Model)
|
||||
|
||||
* @return a the document as a String
|
||||
*/
|
||||
private String buildDocuments() throws IOException {
|
||||
return new OverviewDocument(swagger, markupLanguage).build().toString().concat(
|
||||
new PathsDocument(swagger, markupLanguage, examplesFolderPath).build().toString()
|
||||
.concat(new DefinitionsDocument(swagger, markupLanguage, schemasFolderPath).build().toString()));
|
||||
}
|
||||
|
||||
|
||||
public static class Builder{
|
||||
private final Swagger swagger;
|
||||
@@ -82,10 +144,19 @@ public class Swagger2MarkupConverter {
|
||||
/**
|
||||
* 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.
|
||||
* @param swaggerLocation the Swagger location. Can be a HTTP url or a path to a local file.
|
||||
*/
|
||||
Builder(String swaggerSource){
|
||||
swagger = new SwaggerParser().read(swaggerSource);
|
||||
Builder(String swaggerLocation){
|
||||
swagger = new SwaggerParser().read(swaggerLocation);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a Builder using a given Swagger model.
|
||||
*
|
||||
* @param swagger the Swagger source.
|
||||
*/
|
||||
Builder(Swagger swagger){
|
||||
this.swagger = swagger;
|
||||
}
|
||||
|
||||
public Swagger2MarkupConverter build(){
|
||||
|
||||
@@ -2,11 +2,13 @@ package io.github.robwin.swagger2markup.builder.document;
|
||||
|
||||
import com.wordnik.swagger.models.Model;
|
||||
import com.wordnik.swagger.models.Swagger;
|
||||
import com.wordnik.swagger.models.properties.AbstractProperty;
|
||||
import com.wordnik.swagger.models.properties.Property;
|
||||
import io.github.robwin.markup.builder.MarkupLanguage;
|
||||
import io.github.robwin.swagger2markup.utils.PropertyUtils;
|
||||
import org.apache.commons.collections.MapUtils;
|
||||
import org.apache.commons.io.FileUtils;
|
||||
import org.apache.commons.lang.StringUtils;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
@@ -26,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";
|
||||
@@ -104,13 +104,24 @@ public class DefinitionsDocument extends MarkupDocument {
|
||||
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());
|
||||
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.markupDocBuilder.tableWithHeaderRow(csvContent);
|
||||
}
|
||||
|
||||
private void definitionSchema(String definitionName) throws IOException {
|
||||
|
||||
@@ -15,8 +15,15 @@ import java.nio.charset.Charset;
|
||||
*/
|
||||
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 static final String PRODUCES = "Produces";
|
||||
protected static final String CONSUMES = "Consumes";
|
||||
protected static final String TAGS = "Tags";
|
||||
protected Logger logger = LoggerFactory.getLogger(getClass());
|
||||
protected Swagger swagger;
|
||||
protected MarkupLanguage markupLanguage;
|
||||
|
||||
@@ -0,0 +1,135 @@
|
||||
package io.github.robwin.swagger2markup.builder.document;
|
||||
|
||||
import com.wordnik.swagger.models.*;
|
||||
import io.github.robwin.markup.builder.MarkupLanguage;
|
||||
import org.apache.commons.collections.CollectionUtils;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
public class OverviewDocument extends MarkupDocument {
|
||||
|
||||
private static final String OVERVIEW = "Overview";
|
||||
private static final String CURRENT_VERSION = "Version information";
|
||||
private static final String VERSION = "Version: ";
|
||||
private static final String CONTACT_INFORMATION = "Contact information";
|
||||
private static final String CONTACT_NAME = "Contact: ";
|
||||
private static final String CONTACT_EMAIL = "Contact Email: ";
|
||||
private static final String LICENSE_INFORMATION = "License information";
|
||||
private static final String LICENSE = "License: ";
|
||||
private static final String LICENSE_URL = "License URL: ";
|
||||
private static final String TERMS_OF_SERVICE = "Terms of service: ";
|
||||
private static final String URI_SCHEME = "URI scheme";
|
||||
private static final String HOST = "Host: ";
|
||||
private static final String BASE_PATH = "BasePath: ";
|
||||
private static final String SCHEMES = "Schemes: ";
|
||||
|
||||
public OverviewDocument(Swagger swagger, MarkupLanguage markupLanguage){
|
||||
super(swagger, markupLanguage);
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the MarkupDocument.
|
||||
*
|
||||
* @return the built MarkupDocument
|
||||
* @throws java.io.IOException if the files to include are not readable
|
||||
*/
|
||||
@Override
|
||||
public MarkupDocument build() throws IOException {
|
||||
overview();
|
||||
return this;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Builds the document header of the swagger model
|
||||
*/
|
||||
private void overview() {
|
||||
Info info = swagger.getInfo();
|
||||
this.markupDocBuilder.documentTitle(info.getTitle());
|
||||
this.markupDocBuilder.sectionTitleLevel1(OVERVIEW);
|
||||
if(StringUtils.isNotBlank(info.getDescription())){
|
||||
this.markupDocBuilder.textLine(info.getDescription());
|
||||
this.markupDocBuilder.newLine();
|
||||
}
|
||||
if(StringUtils.isNotBlank(info.getVersion())){
|
||||
this.markupDocBuilder.sectionTitleLevel2(CURRENT_VERSION);
|
||||
this.markupDocBuilder.textLine(VERSION + info.getVersion());
|
||||
this.markupDocBuilder.newLine();
|
||||
}
|
||||
Contact contact = info.getContact();
|
||||
if(contact != null){
|
||||
this.markupDocBuilder.sectionTitleLevel2(CONTACT_INFORMATION);
|
||||
if(StringUtils.isNotBlank(contact.getName())){
|
||||
this.markupDocBuilder.textLine(CONTACT_NAME + contact.getName());
|
||||
}
|
||||
if(StringUtils.isNotBlank(contact.getEmail())){
|
||||
this.markupDocBuilder.textLine(CONTACT_EMAIL + contact.getEmail());
|
||||
}
|
||||
this.markupDocBuilder.newLine();
|
||||
}
|
||||
|
||||
License license = info.getLicense();
|
||||
if(license != null) {
|
||||
this.markupDocBuilder.sectionTitleLevel2(LICENSE_INFORMATION);
|
||||
if (StringUtils.isNotBlank(license.getName())) {
|
||||
this.markupDocBuilder.textLine(LICENSE + license.getName());
|
||||
}
|
||||
if (StringUtils.isNotBlank(license.getUrl())) {
|
||||
this.markupDocBuilder.textLine(LICENSE_URL + license.getUrl());
|
||||
}
|
||||
this.markupDocBuilder.newLine();
|
||||
}
|
||||
if(StringUtils.isNotBlank(info.getTermsOfService())){
|
||||
this.markupDocBuilder.textLine(TERMS_OF_SERVICE + info.getTermsOfService());
|
||||
this.markupDocBuilder.newLine();
|
||||
}
|
||||
|
||||
this.markupDocBuilder.sectionTitleLevel2(URI_SCHEME);
|
||||
if(StringUtils.isNotBlank(swagger.getHost())){
|
||||
this.markupDocBuilder.textLine(HOST + swagger.getHost());
|
||||
}
|
||||
if(StringUtils.isNotBlank(swagger.getBasePath())){
|
||||
this.markupDocBuilder.textLine(BASE_PATH + swagger.getBasePath());
|
||||
}
|
||||
if(CollectionUtils.isNotEmpty(swagger.getSchemes())){
|
||||
List<String> schemes = new ArrayList<>();
|
||||
for(Scheme scheme : swagger.getSchemes()){
|
||||
schemes.add(scheme.toString());
|
||||
}
|
||||
this.markupDocBuilder.textLine(SCHEMES + StringUtils.join(schemes, ", "));
|
||||
|
||||
}
|
||||
this.markupDocBuilder.newLine();
|
||||
|
||||
if(CollectionUtils.isNotEmpty(swagger.getTags())){
|
||||
this.markupDocBuilder.sectionTitleLevel2(TAGS);
|
||||
List<String> tags = new ArrayList<>();
|
||||
for(Tag tag : swagger.getTags()){
|
||||
String name = tag.getName();
|
||||
String description = tag.getDescription();
|
||||
if(StringUtils.isNoneBlank(description)){
|
||||
tags.add(name + ": " + description);
|
||||
}
|
||||
tags.add(name);
|
||||
}
|
||||
this.markupDocBuilder.unorderedList(tags);
|
||||
this.markupDocBuilder.newLine();
|
||||
}
|
||||
|
||||
if(CollectionUtils.isNotEmpty(swagger.getConsumes())){
|
||||
this.markupDocBuilder.sectionTitleLevel2(CONSUMES);
|
||||
this.markupDocBuilder.unorderedList(swagger.getConsumes());
|
||||
this.markupDocBuilder.newLine();
|
||||
}
|
||||
|
||||
if(CollectionUtils.isNotEmpty(swagger.getProduces())){
|
||||
this.markupDocBuilder.sectionTitleLevel2(PRODUCES);
|
||||
this.markupDocBuilder.unorderedList(swagger.getProduces());
|
||||
this.markupDocBuilder.newLine();
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
@@ -1,18 +1,26 @@
|
||||
package io.github.robwin.swagger2markup.builder.document;
|
||||
|
||||
import com.wordnik.swagger.models.*;
|
||||
import com.wordnik.swagger.models.Operation;
|
||||
import com.wordnik.swagger.models.Path;
|
||||
import com.wordnik.swagger.models.Response;
|
||||
import com.wordnik.swagger.models.Swagger;
|
||||
import com.wordnik.swagger.models.parameters.Parameter;
|
||||
import com.wordnik.swagger.models.properties.Property;
|
||||
import io.github.robwin.markup.builder.MarkupLanguage;
|
||||
import io.github.robwin.swagger2markup.utils.ParameterUtils;
|
||||
import io.github.robwin.swagger2markup.utils.PropertyUtils;
|
||||
import org.apache.commons.collections.CollectionUtils;
|
||||
import org.apache.commons.collections.MapUtils;
|
||||
import org.apache.commons.io.FileUtils;
|
||||
import org.apache.commons.lang.StringUtils;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.apache.commons.lang3.text.WordUtils;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Paths;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
@@ -21,20 +29,16 @@ import java.util.Map;
|
||||
*/
|
||||
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 PATHS = "Paths";
|
||||
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 static final String TYPE_COLUMN = "Type";
|
||||
private static final String HTTP_CODE_COLUMN = "HTTP Code";
|
||||
private static final String REQUEST_EXAMPLE_FILE_NAME = "http-request";
|
||||
private static final String RESPONSE_EXAMPLE_FILE_NAME = "http-response";
|
||||
|
||||
private boolean examplesEnabled;
|
||||
private String examplesFolderPath;
|
||||
@@ -58,39 +62,26 @@ public class PathsDocument extends MarkupDocument {
|
||||
|
||||
@Override
|
||||
public MarkupDocument build() throws IOException {
|
||||
documentHeader(swagger.getInfo());
|
||||
paths(swagger.getPaths());
|
||||
paths();
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the document header
|
||||
*
|
||||
* @param info the Swagger Info
|
||||
* Builds all paths of the Swagger model
|
||||
*/
|
||||
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 {
|
||||
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());
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -110,21 +101,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.markupDocBuilder.sectionTitleLevel1(title);
|
||||
this.markupDocBuilder.sectionTitleLevel2(title);
|
||||
this.markupDocBuilder.listing(httpMethod + " " + resourcePath);
|
||||
}else{
|
||||
title = httpMethod + " " + resourcePath;
|
||||
this.markupDocBuilder.sectionTitleLevel1(title);
|
||||
this.markupDocBuilder.sectionTitleLevel2(title);
|
||||
}
|
||||
if (logger.isInfoEnabled()) {
|
||||
logger.info("Path processed: {}", title);
|
||||
@@ -134,7 +125,7 @@ public class PathsDocument extends MarkupDocument {
|
||||
private void descriptionSection(Operation operation) {
|
||||
String description = operation.getDescription();
|
||||
if(StringUtils.isNotBlank(description)){
|
||||
this.markupDocBuilder.sectionTitleLevel2(DESCRIPTION);
|
||||
this.markupDocBuilder.sectionTitleLevel3(DESCRIPTION);
|
||||
this.markupDocBuilder.paragraph(description);
|
||||
}
|
||||
}
|
||||
@@ -142,20 +133,26 @@ public class PathsDocument extends MarkupDocument {
|
||||
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.markupDocBuilder.sectionTitleLevel2(PARAMETERS);
|
||||
this.markupDocBuilder.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.markupDocBuilder.sectionTitleLevel2(CONSUMES);
|
||||
this.markupDocBuilder.sectionTitleLevel3(CONSUMES);
|
||||
this.markupDocBuilder.unorderedList(consumes);
|
||||
}
|
||||
|
||||
@@ -164,11 +161,19 @@ public class PathsDocument extends MarkupDocument {
|
||||
private void producesSection(Operation operation) {
|
||||
List<String> produces = operation.getProduces();
|
||||
if(CollectionUtils.isNotEmpty(produces)){
|
||||
this.markupDocBuilder.sectionTitleLevel2(PRODUCES);
|
||||
this.markupDocBuilder.sectionTitleLevel3(PRODUCES);
|
||||
this.markupDocBuilder.unorderedList(produces);
|
||||
}
|
||||
}
|
||||
|
||||
private void tagsSection(Operation operation) {
|
||||
List<String> tags = operation.getTags();
|
||||
if(CollectionUtils.isNotEmpty(tags)){
|
||||
this.markupDocBuilder.sectionTitleLevel3(TAGS);
|
||||
this.markupDocBuilder.unorderedList(tags);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the example section of a Swagger Operation
|
||||
*
|
||||
@@ -198,7 +203,7 @@ 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.markupDocBuilder.sectionTitleLevel2(title);
|
||||
this.markupDocBuilder.sectionTitleLevel3(title);
|
||||
this.markupDocBuilder.paragraph(FileUtils.readFileToString(path.toFile(), StandardCharsets.UTF_8).trim());
|
||||
if (logger.isInfoEnabled()) {
|
||||
logger.info("Example file processed: {}", path);
|
||||
@@ -216,12 +221,18 @@ 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.markupDocBuilder.sectionTitleLevel2(RESPONSES);
|
||||
this.markupDocBuilder.sectionTitleLevel3(RESPONSES);
|
||||
this.markupDocBuilder.tableWithHeaderRow(csvContent);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -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.lang3.Validate;
|
||||
|
||||
public final class ModelUtils {
|
||||
|
||||
public static String getType(Model model, MarkupLanguage markupLanguage) {
|
||||
Validate.notNull(model, "model must not be null!");
|
||||
if (model instanceof ModelImpl) {
|
||||
return ((ModelImpl) model).getType();
|
||||
} else if (model instanceof RefModel) {
|
||||
switch (markupLanguage){
|
||||
case ASCIIDOC: return "<<" + ((RefModel) model).getSimpleRef() + ">>";
|
||||
default: return ((RefModel) model).getSimpleRef();
|
||||
}
|
||||
} else if (model instanceof ArrayModel) {
|
||||
ArrayModel arrayModel = ((ArrayModel) model);
|
||||
return PropertyUtils.getType(arrayModel.getItems(), markupLanguage) + " " + arrayModel.getType();
|
||||
}
|
||||
return "NOT FOUND";
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,98 @@
|
||||
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.collections.CollectionUtils;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.apache.commons.lang3.Validate;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
|
||||
public final class ParameterUtils {
|
||||
|
||||
public static String getType(Parameter parameter, MarkupLanguage markupLanguage){
|
||||
Validate.notNull(parameter, "property must not be null!");
|
||||
String type = "NOT FOUND";
|
||||
if(parameter instanceof BodyParameter){
|
||||
BodyParameter bodyParameter = (BodyParameter)parameter;
|
||||
Model model = bodyParameter.getSchema();
|
||||
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;
|
||||
List<String> enums = queryParameter.getEnum();
|
||||
if(CollectionUtils.isNotEmpty(enums)){
|
||||
type = "enum" + " (" + StringUtils.join(enums, ", ") + ")";
|
||||
}else{
|
||||
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;
|
||||
List<String> enums = headerParameter.getEnum();
|
||||
if(CollectionUtils.isNotEmpty(enums)){
|
||||
type = "enum" + " (" + StringUtils.join(enums, ", ") + ")";
|
||||
}else{
|
||||
type = getTypeWithFormat(headerParameter.getType(), headerParameter.getFormat());
|
||||
}
|
||||
if(type.equals("array")){
|
||||
String collectionFormat = headerParameter.getCollectionFormat();
|
||||
type = collectionFormat + " " + PropertyUtils.getType(headerParameter.getItems(), markupLanguage) + " " + type;
|
||||
}
|
||||
}
|
||||
else if(parameter instanceof FormParameter){
|
||||
FormParameter formParameter = (FormParameter)parameter;
|
||||
List<String> enums = formParameter.getEnum();
|
||||
if(CollectionUtils.isNotEmpty(enums)){
|
||||
type = "enum" + " (" + StringUtils.join(enums, ", ") + ")";
|
||||
}else{
|
||||
type = getTypeWithFormat(formParameter.getType(), formParameter.getFormat());
|
||||
}
|
||||
if(type.equals("array")){
|
||||
String collectionFormat = formParameter.getCollectionFormat();
|
||||
type = collectionFormat + " " + PropertyUtils.getType(formParameter.getItems(), markupLanguage) + " " + type;
|
||||
}
|
||||
}
|
||||
else if(parameter instanceof CookieParameter){
|
||||
CookieParameter cookieParameter = (CookieParameter)parameter;
|
||||
List<String> enums = cookieParameter.getEnum();
|
||||
if(CollectionUtils.isNotEmpty(enums)){
|
||||
type = "enum" + " (" + StringUtils.join(enums, ", ") + ")";
|
||||
}else{
|
||||
type = getTypeWithFormat(cookieParameter.getType(), cookieParameter.getFormat());
|
||||
}
|
||||
if(type.equals("array")){
|
||||
String collectionFormat = cookieParameter.getCollectionFormat();
|
||||
type = collectionFormat + " " + PropertyUtils.getType(cookieParameter.getItems(), markupLanguage) + " " + type;
|
||||
}
|
||||
}
|
||||
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;
|
||||
}
|
||||
}
|
||||
@@ -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.lang3.StringUtils;
|
||||
import org.apache.commons.lang3.Validate;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
public final class PropertyUtils {
|
||||
|
||||
public static String getType(Property property, MarkupLanguage markupLanguage){
|
||||
Validate.notNull(property, "property must not be null!");
|
||||
String type;
|
||||
if(property instanceof RefProperty){
|
||||
RefProperty refProperty = (RefProperty)property;
|
||||
switch (markupLanguage){
|
||||
case ASCIIDOC: return "<<" + refProperty.getSimpleRef() + ">>";
|
||||
default: return refProperty.getSimpleRef();
|
||||
}
|
||||
}else if(property instanceof ArrayProperty){
|
||||
ArrayProperty arrayProperty = (ArrayProperty)property;
|
||||
Property items = arrayProperty.getItems();
|
||||
type = getType(items, markupLanguage) + " " + arrayProperty.getType();
|
||||
}else if(property instanceof StringProperty){
|
||||
StringProperty stringProperty = (StringProperty)property;
|
||||
List<String> enums = stringProperty.getEnum();
|
||||
if(CollectionUtils.isNotEmpty(enums)){
|
||||
type = "enum" + " (" + StringUtils.join(enums, ", ") + ")";
|
||||
}else{
|
||||
type = property.getType();
|
||||
}
|
||||
}
|
||||
else{
|
||||
if(StringUtils.isNotBlank(property.getFormat())){
|
||||
type = property.getType() + " (" + property.getFormat() + ")";
|
||||
}else{
|
||||
type = property.getType();
|
||||
}
|
||||
}
|
||||
return type;
|
||||
}
|
||||
}
|
||||
@@ -1,12 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<configuration scan="true">
|
||||
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
|
||||
<encoder>
|
||||
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
|
||||
</encoder>
|
||||
</appender>
|
||||
|
||||
<root level="DEBUG">
|
||||
<appender-ref ref="CONSOLE" />
|
||||
</root>
|
||||
</configuration>
|
||||
@@ -1,10 +1,15 @@
|
||||
package io.github.robwin.swagger2markup;
|
||||
|
||||
import io.github.robwin.markup.builder.MarkupLanguage;
|
||||
import org.asciidoctor.*;
|
||||
import org.junit.Test;
|
||||
|
||||
import java.io.BufferedWriter;
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Paths;
|
||||
|
||||
/**
|
||||
* @author Robert Winkler
|
||||
@@ -12,17 +17,53 @@ import java.io.IOException;
|
||||
public class Swagger2MarkupConverterTest {
|
||||
|
||||
@Test
|
||||
public void testSwagger2AsciiDocConverter() throws IOException {
|
||||
public void testSwagger2AsciiDocConversion() throws IOException {
|
||||
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/swagger.json").getFile());
|
||||
|
||||
Swagger2MarkupConverter.from(file.getAbsolutePath()).
|
||||
withExamples("docs").withSchemas("docs/schemas").build()
|
||||
.intoFolder("src/docs/asciidoc/generated");
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testSwagger2MarkdownConversion() 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");
|
||||
.intoFolder("src/docs/markdown/generated");
|
||||
}
|
||||
|
||||
Swagger2MarkupConverter.from(file.getAbsolutePath()).
|
||||
withExamples("docs").withSchemas("docs/schemas").build()
|
||||
.intoFolder("src/docs/asciidoc");
|
||||
@Test
|
||||
public void testSwagger2HtmlConversion() throws IOException {
|
||||
File file = new File(Swagger2MarkupConverterTest.class.getResource("/json/swagger.json").getFile());
|
||||
String asciiDoc = Swagger2MarkupConverter.from(file.getAbsolutePath()).build().asString();
|
||||
String path = "src/docs/generated/asciidocAsString";
|
||||
Files.createDirectories(Paths.get(path));
|
||||
try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(path, "swagger.adoc"), StandardCharsets.UTF_8)){
|
||||
writer.write(asciiDoc); }
|
||||
String asciiDocAsHtml = Asciidoctor.Factory.create().convert(asciiDoc,
|
||||
OptionsBuilder.options().backend("html5").headerFooter(true).safe(SafeMode.UNSAFE).docType("book").attributes(AttributesBuilder.attributes()
|
||||
.tableOfContents(true).tableOfContents(Placement.LEFT).sectionNumbers(true).hardbreaks(true).setAnchors(true).attribute("sectlinks")));
|
||||
try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(path, "swagger.html"), StandardCharsets.UTF_8)){
|
||||
writer.write(asciiDocAsHtml);
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testSpica2HtmlConversion() 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/generated/asciidocAsString";
|
||||
Files.createDirectories(Paths.get(path));
|
||||
try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(path, "spica.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, "spica.html"), StandardCharsets.UTF_8)){
|
||||
writer.write(asciiDocAsHtml);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
"info": {
|
||||
"description": "This is a sample server Petstore server.\n\n[Learn about Swagger](http://swagger.wordnik.com) or join the IRC channel `#swagger` on irc.freenode.net.\n\nFor this sample, you can use the api key `special-key` to test the authorization filters\n",
|
||||
"version": "1.0.0",
|
||||
"title": "Swagger Petstore",
|
||||
"title": "Swagger Petstore API",
|
||||
"termsOfService": "http://helloreverb.com/terms/",
|
||||
"contact": {
|
||||
"name": "apiteam@wordnik.com"
|
||||
|
||||
Reference in New Issue
Block a user