diff --git a/1.0.0-SNAPSHOT/index.html b/1.0.0-SNAPSHOT/index.html index 3716243a..1ccd6408 100644 --- a/1.0.0-SNAPSHOT/index.html +++ b/1.0.0-SNAPSHOT/index.html @@ -516,7 +516,7 @@ table.CodeRay td.code>pre{padding:0}
Robert Winkler
version 1.0.0-SNAPSHOT, -2016-04-13 +2016-04-14
Table of Contents
@@ -588,11 +588,12 @@ table.CodeRay td.code>pre{padding:0}
  • 5.3.5. SwaggerModelExtension
    • -
  • 5.4. Provided Extensions +
  • 5.4. Content markup language
    • +
  • 5.5. Provided Extensions
    • @@ -600,14 +601,14 @@ table.CodeRay td.code>pre{padding:0}
  • 6. Gradle Plugin
  • 7. Maven Plugin
    • @@ -621,7 +622,7 @@ table.CodeRay td.code>pre{padding:0}
  • 8.1.4. Conversion of a remote Swagger file
    • -
  • 8.2. Configuration
    • +
  • 8.2. Configuration
  • 9. Spring Boot and Springfox @@ -1855,7 +1856,50 @@ Extension content titles must always start from level 1. The ti
    • -

    5.4. Provided Extensions

    +

    5.4. Content markup language

    +
    +

    Most content extensions supports to provide content in any markup language which will be converted, if needed, to configured Swagger2Markup converter markup language at import.

    +
    +
    +

    The content files markup language can be any markup-document-builder supported language :

    +
    +
    + +
    +
    + + + + + +
    + + +
    +

    Currently supported conversions are :

    +
    +
    +
      +
    • +

      Markdown → AsciiDoc

      +
      • +
    +
    +
    +
    +
    +
    +

    5.5. Provided Extensions

    Swagger2Markup provides some extensions which can be used out-of-the-box. You just have to add the extension to your classpath.

    @@ -1873,21 +1917,21 @@ Extension content titles must always start from level 1. The ti -

    Dynamic file import extension

    +

    Dynamic file import extension

    Allows to dynamically import Markup from files.

    -

    Spring RestDocs extension

    +

    Spring RestDocs extension

    Allows to import Curl, HTTP request and response snippets from Spring Rest Docs.

    -

    Schema file import extension

    +

    Schema file import extension

    Allows to import JSON or XML Schema files.

    -

    5.4.1. Dynamic file import extension

    +

    5.5.1. Dynamic file import extension

    Usage guide
    @@ -1909,7 +1953,7 @@ compile "io.github.swagger2markup:swagger2markup-import-files-ext:1.0.0-SNAPSHOT

    See documentation of Extensions points.

    -

    Here the list of all document naming conventions, just replace * with an arbitrary, meaningful, identifier.

    +

    Here the list of all document naming conventions for each position. You have to replace * with an arbitrary, meaningful, identifier.

    @@ -1924,34 +1968,34 @@ You can provide multiple contents for the same position, just specify different
    -

    All documents, relatively to each extension contentPath :

    +

    All extensions, relatively to each extension contentPath :

    • -

      document-before-*.<markup.ext>

      +

      DOCUMENT_BEFORE : document-before-*.<markup.ext>

    • -

      document-begin-*.<markup.ext>

      +

      DOCUMENT_BEGIN : document-begin-*.<markup.ext>

    • -

      document-end-*.<markup.ext>

      +

      DOCUMENT_END : document-end-*.<markup.ext>

    • -

      document-after-*.<markup.ext>

      +

      DOCUMENT_AFTER : document-after-*.<markup.ext>

    -

    Paths document, relatively to swagger2markup.extensions.dynamicPaths.contentPath :

    +

    Paths extensions, relatively to each extension contentPath :

    @@ -1962,21 +2006,21 @@ You can provide multiple contents for the same position, just specify different -<operationId> value depends on Swagger specification. If you provided an operationId for operations in the Swagger document, the value will be used primarily. Otherwise, the value normalized(operation.summary + " " + lowerCase(operation.HTTPmethod)) will be used. It is highly recommended to set operationId for operations because it’s more stable : see Advanced usage - Swagger operationId. In all cases, <operationId> is case-sensitive. +<operationId> value depends on Swagger specification. If you provided an operationId for operations in the Swagger document, the value will be used primarily. It is highly recommended to set operationId for operations : see Swagger operationId. In all cases, <operationId> is case-sensitive.
    -

    Definitions and Security document, relatively to swagger2markup.extensions.dynamicDefinitions.contentPath :

    +

    Definitions and Security extensions, relatively to each extension contentPath :

    • -

      <definitionName>/definition-begin-*.<markup.ext>

      +

      DEFINITION_BEGIN : <definitionName>/definition-begin-*.<markup.ext>

    • -

      <definitionName>/definition-end-*.<markup.ext>

      +

      DEFINITION_END : <definitionName>/definition-end-*.<markup.ext>

    @@ -2008,51 +2052,16 @@ Pet/definition-begin-description.adoc
    -
    Content markup language
    +
    Content markup language
    -

    The content files markup language can be any markup-document-builder supported language :

    -
    -
    - +

    See Extensions content markup language

    -

    By default, the markup language is set to ASCIIDOC, whatever the file extension. Set extension Configuration to change content markup language.
    -The content file will be converted, if needed, to main Swagger2Markup converter markup language at import.

    -
    -
    - - - - - -
    - - -
    -

    Currently supported conversion are :

    -
    -
    -
      -
    • -

      Markdown → AsciiDoc

      -
      • -
    -
    -
    +

    By default, the markup language is set to ASCIIDOC. Set extension Configuration to change content markup language.

    -
    Configuration
    +
    Configuration

    The extension adds the following properties to Swagger2Markup which must be configured:

    @@ -2126,7 +2135,7 @@ The content file will be converted, if needed, to main Swagger2Markup co
    -

    5.4.2. Spring RestDocs extension

    +

    5.5.2. Spring RestDocs extension

    Swagger2Markup can be used together with spring-restdocs. Swagger2Markup can include the generated CURL request, HTTP request and HTTP response example snippets from spring-restdocs into the generated Markup documents. See spring-restdocs how to configure it.

    @@ -2142,35 +2151,44 @@ compile "io.github.swagger2markup:swagger2markup-spring-restdocs-ext:1.0.0-SNAPS
    -

    The extension searches for Spring RestDocs snippet files in a configurable path to append the snippets at the end of a path operation section. The files must conform to the naming convention:

    +

    The extension searches for Spring RestDocs snippet files in a configurable path to append the snippets at the end of a path operation section. By default the following snippets are searched :

    -
    -

    The files must be stored in a folder which matches the Swagger operationId.

    +
    + + + + + +
    + + +<operationId> value depends on Swagger specification. If you provided an operationId for operations in the Swagger document, the value will be used primarily. It is highly recommended to set operationId for operations : see Swagger operationId. In all cases, <operationId> is case-sensitive. +

    Swagger Example:

    -
    paths:
-  /pets:
-    post:
-      summary: Add a new pet to the store
-      operationId: addPet
-      ...
    +
    paths:
+  /pets:
+    post:
+      summary: Add a new pet to the store
+      operationId: addPet
+      ...
    @@ -2195,21 +2213,32 @@ compile "io.github.swagger2markup:swagger2markup-spring-restdocs-ext:1.0.0-SNAPS
    -
    Configuration
    +
    Content markup language
    +
    +

    See Extensions content markup language

    +
    +
    +

    By default, the markup language is set to ASCIIDOC. Set extension Configuration to change content markup language.

    +
    +
    +
    +
    Configuration

    The extension adds the following properties to Swagger2Markup which must be configured:

    ---++++ + @@ -2217,14 +2246,27 @@ compile "io.github.swagger2markup:swagger2markup-spring-restdocs-ext:1.0.0-SNAPS + + + + + + + + + + + + +
    Table 10. Extension properties
    Name DescriptionDefault Example

    swagger2markup.extensions.springRestDocs.snippetBaseUri

    The path to the Spring RestDocs snippets

    -

    src/test/resources/docs/asciidoc/paths

    swagger2markup.extensions.springRestDocs.markupLanguage

    The markup language of the content files

    ASCIIDOC

    MARKDOWN

    swagger2markup.extensions.springRestDocs.defaultSnippets

    Boolean value. Set to false to disable default snippet files

    true

    false
    -

    5.4.3. Schema file import extension

    +

    5.5.3. Schema file import extension

    Usage guide
    @@ -2244,7 +2286,7 @@ compile "io.github.swagger2markup:swagger2markup-import-schemas-ext:1.0.0-SNAPSH
    -
    Configuration
    +
    Configuration

    The extension adds the following properties to Swagger2Markup which must be configured:

    @@ -2322,7 +2364,7 @@ apply plugin: 'io.github.swagger2markup'
    -

    6.2. Configuration

    +

    6.2. Configuration

    You can customize the task by configuring a Map of Swagger2Markup properties.

    @@ -2451,7 +2493,7 @@ The Maven Plugin requires at least JDK 8.
    -

    7.2. Configuration

    +

    7.2. Configuration

    You can customize the task by configuring a Map of Swagger2Markup properties.

    @@ -2657,7 +2699,7 @@ The input file must not have a file extension
    -

    8.2. Configuration

    +

    8.2. Configuration

    Create a config.properties file to customize the Swagger2Markup properties. For Example:

    @@ -2833,7 +2875,7 @@ The Swagger JSON response can be converted using the G