mindol1004/swagger2markup
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added Gradle Plugin documentation

Browse Source
This commit is contained in:
Robert Winkler
2016-04-04 13:55:52 +02:00
parent 9fe3bf9ec0
commit 4973f9674a
2 changed files with 24 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/docs/asciidoc/command_line_interface.adoc
View File

@@ -62,9 +62,11 @@ You can convert a local Swagger file into a file as follows:
[source, subs="attributes"]
----
java -jar swagger2markup-cli-1.0.0-SNAPSHOT.jar convert -i /path/to/swagger_petstore.yaml -o /tmp/swagger.adoc
java -jar swagger2markup-cli-1.0.0-SNAPSHOT.jar convert -i /path/to/swagger_petstore.yaml -o /tmp/swagger
----
NOTE: The input file must not have a file extension
It generates the Markup documents into the file `/tmp/swagger.adoc`.
==== Conversion of a remote Swagger file

23
src/docs/asciidoc/gradle_plugin.adoc
View File

@@ -20,15 +20,34 @@ buildscript {
apply plugin: 'io.github.swagger2markup'
----
The plugin adds a new task named ``convertSwagger2markup``. You can customize the task by configuring a Map of <<Swagger2Markup properties>>.
The plugin adds a new task named ``convertSwagger2markup``. You can run the task as follows:
[source,java]
`gradlew convertSwagger2markup`
You can customize the task by configuring a Map of <<Swagger2Markup properties>>.
[source,groovy]
----
convertSwagger2markup {
swaggerInput file("src/docs/asciidoc")
markupOutputFile file("${buildDir}/asciidoc")
config = [(Swagger2MarkupProperties.MARKUP_LANGUAGE) : MarkupLanguage.ASCIIDOC.toString(),
(Swagger2MarkupProperties.PATHS_GROUPED_BY) : GroupBy.TAGS.toString()]
}
----
[options="header"]
.Gradle Plugin properties
|====
| Name | Description | Type | Example | Default
| swaggerInput | The directory or file path to the Swagger specification | File | `file("src/docs/swagger_petstore.yaml")` (file) or `file("src/docs/swagger")` (directory) | ``file("src/docs/swagger")``
| markupOutputDir | The directory where the output should be stored. | String | `new File("/tmp/asciidoc")` | ``file("$buildDir/asciidoc")``
| markupOutputFile | The file (without extensions) where the output should be stored. | String | ``file("$buildDir/asciidoc/swagger")`` |
| config | The Swagger2Markup properties to configure the converter | Map | ['swagger2markup.markupLanguage' : 'ASCCIDOC'] |
|====