Compare commits
2 Commits
master
...
feature/sw
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
85c5b7aa97 | ||
|
|
662cc3f40f |
82
.github/workflows/gradle-build.yml
vendored
@@ -1,82 +0,0 @@
|
||||
# This workflow will build a Java project with Gradle
|
||||
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-gradle
|
||||
name: Build
|
||||
on:
|
||||
push:
|
||||
branches: [ master ]
|
||||
pull_request:
|
||||
branches: [ master ]
|
||||
jobs:
|
||||
validation:
|
||||
name: "Gradle wrapper validation"
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2.3.5
|
||||
- uses: gradle/wrapper-validation-action@v1.0.4
|
||||
build:
|
||||
name: "Build and publish"
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2.3.5
|
||||
with:
|
||||
fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
|
||||
- name: Set up JDK 11
|
||||
uses: actions/setup-java@v2
|
||||
with:
|
||||
java-version: '11'
|
||||
distribution: 'temurin'
|
||||
- name: Cache SonarCloud packages
|
||||
uses: actions/cache@v2.1.6
|
||||
if: env.SONAR_TOKEN != null && env.SONAR_TOKEN != ''
|
||||
env:
|
||||
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
||||
with:
|
||||
path: ~/.sonar/cache
|
||||
key: ${{ runner.os }}-sonar
|
||||
restore-keys: ${{ runner.os }}-sonar
|
||||
- name: Build
|
||||
id: gradle
|
||||
uses: eskatos/gradle-command-action@v1
|
||||
with:
|
||||
arguments: check
|
||||
wrapper-cache-enabled: true
|
||||
dependencies-cache-enabled: true
|
||||
configuration-cache-enabled: true
|
||||
- name: "Comment build scan url"
|
||||
uses: actions/github-script@v5
|
||||
if: github.event_name == 'pull_request' && failure()
|
||||
with:
|
||||
github-token: ${{secrets.GITHUB_TOKEN}}
|
||||
script: |
|
||||
github.issues.createComment({
|
||||
issue_number: context.issue.number,
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
body: '❌ ${{ github.workflow }} failed: ${{ steps.gradle.outputs.build-scan-url }}'
|
||||
})
|
||||
- name: Publish Unit Test Results
|
||||
uses: EnricoMi/publish-unit-test-result-action/composite@v1
|
||||
if: always()
|
||||
with:
|
||||
files: '**/test-results/**/*.xml'
|
||||
- name: Analyze with SonarCloud
|
||||
continue-on-error: true
|
||||
if: env.SONAR_TOKEN != null && env.SONAR_TOKEN != ''
|
||||
uses: eskatos/gradle-command-action@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
|
||||
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
||||
with:
|
||||
arguments: sonarqube -Psonar.organization=swagger2markup
|
||||
dependencies-cache-enabled: true
|
||||
configuration-cache-enabled: true
|
||||
- name: Publish to Sonatype
|
||||
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
|
||||
uses: eskatos/gradle-command-action@v1
|
||||
env:
|
||||
ORG_GRADLE_PROJECT_sonatypeUsername: ${{ secrets.SONATYPE_USER }}
|
||||
ORG_GRADLE_PROJECT_sonatypePassword : ${{ secrets.SONATYPE_PASSWORD }}
|
||||
with:
|
||||
arguments: publishToSonatype
|
||||
dependencies-cache-enabled: true
|
||||
configuration-cache-enabled: true
|
||||
5
.gitignore
vendored
@@ -3,8 +3,3 @@
|
||||
.gradle
|
||||
build
|
||||
/bin/
|
||||
/.classpath
|
||||
/.project
|
||||
/.settings/
|
||||
*.ipr
|
||||
*.iws
|
||||
18
.travis.yml
Normal file
@@ -0,0 +1,18 @@
|
||||
language: java
|
||||
jdk:
|
||||
- oraclejdk8
|
||||
before_install:
|
||||
- chmod +x gradlew
|
||||
after_success:
|
||||
- ./gradlew jacocoTestReport coveralls
|
||||
- ./gradlew artifactoryPublish -PbintrayUsername="${BINTRAY_USER}" -PbintrayApiKey="${BINTRAY_KEY}"
|
||||
- ./gradlew publishGhPages -PgithubUser="${GITHUB_USER}" -PgithubPassword="${GITHUB_PASSWORD}"
|
||||
--stacktrace
|
||||
notifications:
|
||||
slack: swagger2markup:Zz5kz0SnvtG6aVvZUM8yMkER
|
||||
env:
|
||||
global:
|
||||
- secure: SPKolgUdjIa/uJ+7/B/GPFlsa8IZg7NuZdFA8zROTaqew/xu+oX7qVGImseeBpPIEPJb02ac6hr7Y3/zvv0GJxIPtIbyDzVh73ImQUhT1ttLYGJfITAWqAPFF7RNNMtuOl3S2DLZ5OMJddkcFp00pa9nyI82Gk47B8GsaGIntAI=
|
||||
- secure: nXXuHfvFACZwdiFM3Ta0x/f49N7cAgi0AMkgEnQrh/2xWlvQk2z2ySGJQLkhJ7Wy8LDY7Yt1b1GUt6DlP3PuFFMW/cT4iARewqiJRXZXxUQz8fpTDeTo1nmVmW/zzII6Qj3QHM3NRbR/xDOVSJiT30Hnq2hcCBQJWYsTICmzjRk=
|
||||
- secure: Ia/wJ572M2II76roFeGEVCzIiktG4v2j/reSn60fpk1gnoEPQEObL4j1dbVCgXBLz54YWcaQ3mICvOfBPPEl9IIV3Y6DDE2sBOmB3soznfdA/YVnJx0h0f1pfXu1dwqoiv1sgc1wewQuUWq+FV7xeDhFE3cnh9CXIexe9ykip8k=
|
||||
- secure: GWfhYDsHRmTfOuEOIcHY8kT4jKBTbdhNLDQ/2amY06xenFblb4pEn6pgmn4IdK3ytjNovnZPTOOK8HqdEjhbfIGoQt6PZwuyANn4Df+zdqOC0+V+7DFG2QhEhbRCyEwPlDqTPjxlOMfAmvjFuY/NvQywoF3PYUyMfJwUV8ehmYk=
|
||||
21
README.adoc
@@ -2,22 +2,11 @@
|
||||
:author: Robert Winkler
|
||||
:hardbreaks:
|
||||
|
||||
image:https://coveralls.io/repos/Swagger2Markup/swagger2markup/badge.svg["Coverage Status", link="https://coveralls.io/r/Swagger2Markup/swagger2markup"] image:https://api.codacy.com/project/badge/grade/498a6a39d7d84ff687546359f58ee18d["Codacy code quality", link="https://www.codacy.com/app/robwin/swagger2markup"] image:https://api.bintray.com/packages/swagger2markup/Maven/swagger2markup/images/download.svg[link="https://bintray.com/swagger2markup/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://img.shields.io/badge/Twitter-rbrtwnklr-blue.svg["Twitter", link="https://twitter.com/rbrtwnklr"] 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"]
|
||||
image:https://travis-ci.org/Swagger2Markup/swagger2markup.svg?branch=master["Build Status", link="https://travis-ci.org/Swagger2Markup/swagger2markup"] image:https://coveralls.io/repos/Swagger2Markup/swagger2markup/badge.svg["Coverage Status", link="https://coveralls.io/r/Swagger2Markup/swagger2markup"] image:https://api.codacy.com/project/badge/grade/498a6a39d7d84ff687546359f58ee18d["Codacy code quality", link="https://www.codacy.com/app/robwin/swagger2markup"] image:https://api.bintray.com/packages/swagger2markup/Maven/swagger2markup/images/download.svg[link="https://bintray.com/swagger2markup/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://img.shields.io/badge/Twitter-rbrtwnklr-blue.svg["Twitter", link="https://twitter.com/rbrtwnklr"] 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
|
||||
|
||||
|
||||
NOTE: Dear community,
|
||||
unfortunately I can't maintain Swagger2Markup alone anymore. There are many interesting new topics:
|
||||
1) Swagger v3 support
|
||||
2) Fixing bugs
|
||||
2) Merge Swagger2Markup repositories and create a new multi-module repository.
|
||||
Any help is welcome.
|
||||
Kind regards,
|
||||
Robert
|
||||
|
||||
|
||||
The primary goal of this project is to *simplify the generation of an up-to-date RESTful API documentation 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 *up-to-date, easy-to-read, on- and offline user guide*, comparable to https://developer.github.com/v3/[GitHub's API documentation]. The output of Swagger2Markup can be used as an alternative to https://github.com/swagger-api/swagger-ui[swagger-ui] and can be served as static content.
|
||||
NOTE: The Swagger Specification has been donated to to the https://openapis.org/[Open API Initiative (OAI)] and has been renamed to the https://github.com/OAI/OpenAPI-Specification[OpenAPI Specification].
|
||||
|
||||
@@ -33,12 +22,12 @@ The project requires at least JDK 8.
|
||||
|
||||
== Example
|
||||
|
||||
image::swagger2markup-documentation/src/docs/asciidoc/images/Swagger2Markup.PNG[]
|
||||
image::src/docs/asciidoc/images/Swagger2Markup.PNG[]
|
||||
|
||||
image::swagger2markup-documentation/src/docs/asciidoc/images/Swagger2Markup_definitions.PNG[]
|
||||
image::src/docs/asciidoc/images/Swagger2Markup_definitions.PNG[]
|
||||
|
||||
== Reference documentation
|
||||
- http://swagger2markup.github.io/swagger2markup/1.3.3/[Reference Documentation]
|
||||
- http://swagger2markup.github.io/swagger2markup/1.0.0/[Reference Documentation]
|
||||
- https://github.com/Swagger2Markup/swagger2markup/blob/master/RELEASENOTES.adoc[Release notes]
|
||||
- https://github.com/Swagger2Markup/spring-swagger2markup-demo[Demo using Swagger2Markup, Spring Boot, Springfox and spring-restdocs]
|
||||
|
||||
@@ -65,8 +54,6 @@ If you’d like an enhancement to be made to Swagger2Markup, pull requests are m
|
||||
* http://www.appdirect.com/[AppDirect] -- The leading commerce platform for selling cloud services.
|
||||
* http://www.wescale.com[wescale]
|
||||
* http://taskassure.com[TaskAssure]
|
||||
* https://www.isaac.nl[ISAAC]
|
||||
* https://www.spreadshirt.de[Spreadshirt]
|
||||
|
||||
== License
|
||||
|
||||
|
||||
@@ -3,21 +3,6 @@
|
||||
== Version 0.1.0
|
||||
* Initial version with support for AsciiDoc and Markdown
|
||||
|
||||
=== Version 0.1.1
|
||||
* Signed jar files
|
||||
|
||||
=== Version 0.1.2
|
||||
* Removed logback from compile dependency
|
||||
|
||||
=== Version 0.1.3
|
||||
* Removed commons.io from compile dependency
|
||||
|
||||
=== Version 0.1.4
|
||||
* Fixed SECTION_TITLE_LEVEL3 in Markdown enum
|
||||
|
||||
=== Version 0.1.5
|
||||
* Added SECTION_TITLE_LEVEL4
|
||||
|
||||
== Version 0.2.0
|
||||
* This version is not downward compatible. This version supports includes of example files and JSON/XML Schema files. See documentation.
|
||||
|
||||
@@ -93,9 +78,9 @@
|
||||
|
||||
=== Version 0.9.3
|
||||
* Updated swagger-parser from v1.0.13 to v1.0.16
|
||||
* Enhancement #61: Refactor separated documents logic to support inter-document cross-references
|
||||
* Enhancement #53: Support for tags, paths and methods ordering
|
||||
* Enhancement #51: Support for separated operations files
|
||||
* Enhancement #61 Refactor separated documents logic to support inter-document cross-references
|
||||
* Enhancement #53 : support for tags, paths and methods ordering
|
||||
* Enhancement #51 : Support for separated operations files
|
||||
* Enhancement #52: Markdown generation for inline schemas
|
||||
|
||||
== Version 1.0.0
|
||||
@@ -106,64 +91,3 @@
|
||||
* Inline schema support
|
||||
* New configuration options
|
||||
* Support of deprecated path operations
|
||||
|
||||
=== Version 1.0.1
|
||||
* Enhancement: Support to render validation constraints of properties
|
||||
* Enhancement: Possibility to disable rendering of the security chapter below operations
|
||||
|
||||
== Version 1.1.0
|
||||
* PR #177: Fixed rendering of recursive examples
|
||||
* PR #186: Add support for Chinese language
|
||||
* PR #190: Add support for Spanish language
|
||||
* PR #192: Updated min/max value to format correctly based on the data type
|
||||
* PR #193: Added support for exclusiveMin and exclusiveMax
|
||||
* Changed bold to ** and italic to __ so that special chars in the text are possible
|
||||
|
||||
=== Version 1.1.1
|
||||
* Issue #194: Added a config parameter which allows to prepend the basePath to all paths.
|
||||
* Updated swagger-parser from v1.0.16 to v1.0.23
|
||||
* Added javslang v2.0.4 as a dependency
|
||||
* Added paleo-core v0.10.1 as a dependency
|
||||
* Updated markup-document-builder from 1.0.0 to 1.1.0
|
||||
* PR #201: Add support for Brazilian Portuguese language
|
||||
* PR #202: Add support for Japanese language
|
||||
* Issue #205: Fixed the option to influence resource ordering
|
||||
* Issue #198: Chinese chinese language encoding
|
||||
* Issue #207: Properties that start with an underscore are displayed correctly now
|
||||
* Refactored Swagger2Markup to use a Component-Based design. A document can be composed of components and components can be composed of other components.
|
||||
* Added a method to add page breaks.
|
||||
|
||||
== Version 1.1.2
|
||||
* Improve code blocks in markdown
|
||||
|
||||
== Version 1.2.0
|
||||
* Issue #214: Add page break locations
|
||||
* Issue #223: Improve example rendering
|
||||
* Issue #215: Add ability to group operations by RegEx
|
||||
* Added new configuration options: pageBreakLocations, headerRegex
|
||||
* Added new valid value for configuration headerRegex: REGEX
|
||||
* Updated markup-document-builder from 1.1.0 to 1.1.1
|
||||
|
||||
== Version 1.3.0
|
||||
* Updated javslang from 2.0.4 to 2.0.5
|
||||
* Updated paleo-core from 0.10.1 to 0.10.2
|
||||
* Updated swagger-parser from v1.0.23 to v1.0.25
|
||||
* Decimal numbers are formatted into locale-specific strings
|
||||
|
||||
=== Version 1.3.1
|
||||
* PR #247: Fix request path and query params example support.
|
||||
|
||||
=== Version 1.3.2
|
||||
* PR #290: Fixed list parsing in properties file
|
||||
* PR #293: Fixed crash on empty tables
|
||||
* Updated markup-document-builder from 1.1.1 to 1.1.2
|
||||
|
||||
=== Version 1.3.3
|
||||
* Updated swagger-parser from v1.0.25 to 1.0.35
|
||||
* PR #294: Examples always start with a newline if there is other content in the same cell
|
||||
* PR 307: Include required parameters in example request
|
||||
|
||||
=== Version 2.0.0
|
||||
* Added openapi2markup to support OpenAPI v3
|
||||
* Issue #409: Fixed JSON response example
|
||||
|
||||
|
||||
154
build.gradle
@@ -1,121 +1,67 @@
|
||||
plugins {
|
||||
id "org.sonarqube" version "2.7"
|
||||
id "me.champeau.gradle.jmh" version "0.4.8"
|
||||
id 'org.asciidoctor.convert' version '1.6.0'
|
||||
id "org.ajoberstar.github-pages" version "1.7.2"
|
||||
id "io.github.gradle-nexus.publish-plugin" version "1.1.0"
|
||||
}
|
||||
apply plugin: 'idea'
|
||||
apply from: "${rootDir}/libraries.gradle"
|
||||
|
||||
ext {
|
||||
releaseVersion = '1.3.3'
|
||||
}
|
||||
|
||||
allprojects {
|
||||
apply plugin: 'jacoco'
|
||||
apply plugin: 'me.champeau.gradle.jmh'
|
||||
|
||||
version = '2.0.0-SNAPSHOT'
|
||||
group 'io.github.swagger2markup'
|
||||
description = 'swagger2markup Build'
|
||||
|
||||
buildscript {
|
||||
repositories {
|
||||
jcenter()
|
||||
mavenCentral()
|
||||
}
|
||||
}
|
||||
//artifactoryPublish.skip = true // apply to all projects except the root
|
||||
|
||||
ext {
|
||||
coreProjects = subprojects.findAll {
|
||||
p -> !p.name.contains("documentation") && !p.name.endsWith("-bom")
|
||||
dependencies {
|
||||
classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.3'
|
||||
classpath 'org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.10.1'
|
||||
classpath 'org.kt3k.gradle.plugin:coveralls-gradle-plugin:2.0.1'
|
||||
classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.6'
|
||||
classpath "org.jfrog.buildinfo:build-info-extractor-gradle:4.0.0"
|
||||
classpath "org.ajoberstar:gradle-git:1.3.2"
|
||||
}
|
||||
}
|
||||
description = 'swagger2markup Build'
|
||||
version = '1.0.1-SNAPSHOT'
|
||||
group = 'io.github.swagger2markup'
|
||||
|
||||
configure(project.coreProjects) {
|
||||
apply plugin: 'java'
|
||||
apply plugin: 'java-library'
|
||||
apply plugin: 'maven'
|
||||
apply plugin: 'maven-publish'
|
||||
apply from: "${rootDir}/publishing.gradle"
|
||||
apply plugin: 'jacoco'
|
||||
apply plugin: 'java'
|
||||
apply from: 'gradle/publishing.gradle'
|
||||
apply from: 'gradle/coverage.gradle'
|
||||
apply from: 'gradle/documentation.gradle'
|
||||
|
||||
tasks.withType(JavaCompile) {
|
||||
sourceCompatibility = "11"
|
||||
targetCompatibility = "11"
|
||||
options.deprecation = true
|
||||
options.encoding = 'UTF-8'
|
||||
options.compilerArgs += ["-Xlint:unchecked", "-parameters"]
|
||||
}
|
||||
tasks.withType(Javadoc){
|
||||
options.encoding = 'UTF-8'
|
||||
}
|
||||
jmh {
|
||||
duplicateClassesStrategy = 'warn'
|
||||
}
|
||||
configurations.all {
|
||||
resolutionStrategy {
|
||||
failOnVersionConflict()
|
||||
}
|
||||
}
|
||||
tasks.withType(JavaCompile) {
|
||||
sourceCompatibility = "1.8"
|
||||
targetCompatibility = "1.8"
|
||||
options.deprecation = true
|
||||
options.encoding = 'UTF-8'
|
||||
options.compilerArgs << "-Xlint:unchecked"
|
||||
}
|
||||
|
||||
nexusPublishing {
|
||||
repositories {
|
||||
sonatype()
|
||||
repositories {
|
||||
maven {
|
||||
url "https://oss.jfrog.org/artifactory/oss-snapshot-local"
|
||||
}
|
||||
jcenter()
|
||||
mavenCentral()
|
||||
mavenLocal()
|
||||
}
|
||||
|
||||
sonarqube {
|
||||
properties {
|
||||
property "sonar.host.url", "https://sonarcloud.io"
|
||||
property "sonar.organization", "swagger2markup"
|
||||
property "sonar.projectName", "swagger2markup"
|
||||
property "sonar.projectKey", "Swagger2Markup_swagger2markup"
|
||||
property "sonar.links.homepage", "https://github.com/Swagger2Markup/swagger2markup"
|
||||
property "sonar.links.ci", "https://travis-ci.org/Swagger2Markup/swagger2markup"
|
||||
property "sonar.links.scm", "https://github.com/Swagger2Markup/swagger2markup"
|
||||
property "sonar.links.issue", "https://github.com/Swagger2Markup/swagger2markup/issues"
|
||||
property "sonar.language", "java"
|
||||
}
|
||||
dependencies {
|
||||
compile 'io.github.swagger2markup:markup-document-builder:1.0.0'
|
||||
compile 'io.swagger:swagger-compat-spec-parser:1.0.21-SNAPSHOT'
|
||||
compile 'org.apache.commons:commons-configuration2:2.0'
|
||||
compile 'commons-beanutils:commons-beanutils:1.9.2'
|
||||
compile 'org.apache.commons:commons-collections4:4.1'
|
||||
testCompile 'junit:junit:4.11'
|
||||
testCompile 'org.asciidoctor:asciidoctorj:1.5.4'
|
||||
testCompile 'ch.qos.logback:logback-classic:1.1.2'
|
||||
testCompile 'org.assertj:assertj-core:3.4.0'
|
||||
testCompile 'io.github.robwin:assertj-diff:0.1.1'
|
||||
}
|
||||
def allTestCoverageFile = "$buildDir/jacoco/allTestCoverage.exec"
|
||||
|
||||
task jacocoMergeTest(type: JacocoMerge) {
|
||||
destinationFile = file(allTestCoverageFile)
|
||||
executionData = project.fileTree(dir: '.', include: '**/build/jacoco/test.exec')
|
||||
}
|
||||
|
||||
task jacocoMerge(dependsOn: ['jacocoMergeTest']) {
|
||||
// used to run the other merge tasks
|
||||
}
|
||||
|
||||
subprojects {
|
||||
sonarqube {
|
||||
properties {
|
||||
property "sonar.jacoco.reportPaths", allTestCoverageFile
|
||||
}
|
||||
}
|
||||
afterEvaluate {
|
||||
// exclude subprojects that don't produce a jar file or by design.
|
||||
if (!project.name.equals('swagger2markup-bom') && !project.name.equals('swagger2markup-documentation')) {
|
||||
jar {
|
||||
into("META-INF/maven/$project.group/$project.name") {
|
||||
from {generatePomFileForMavenJavaPublication}
|
||||
rename ".*", "pom.xml"
|
||||
}
|
||||
inputs.property('moduleName', moduleName)
|
||||
manifest.attributes(
|
||||
'Automatic-Module-Name': moduleName
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
tasks.check.dependsOn tasks.jacocoTestReport
|
||||
|
||||
test {
|
||||
dependsOn(subprojects.test) // required by cobertura to aggregate report
|
||||
if (System.properties['http.proxyHost']) {
|
||||
systemProperty 'http.proxyHost', System.properties['http.proxyHost']
|
||||
systemProperty 'http.proxyPort', System.properties['http.proxyPort']
|
||||
systemProperty 'http.nonProxyHosts', System.properties['http.nonProxyHosts']
|
||||
}
|
||||
systemProperty 'file.encoding', 'UTF-8'
|
||||
ignoreFailures = true
|
||||
}
|
||||
|
||||
|
||||
task wrapper(type: Wrapper) {
|
||||
gradleVersion = '2.12'
|
||||
}
|
||||
|
||||
@@ -1,2 +0,0 @@
|
||||
systemProp.file.encoding=UTF-8
|
||||
systemProp.sun.jnu.encoding=UTF-8
|
||||
13
gradle/coverage.gradle
Normal file
@@ -0,0 +1,13 @@
|
||||
apply plugin: 'jacoco'
|
||||
apply plugin: 'com.github.kt3k.coveralls'
|
||||
|
||||
jacocoTestReport {
|
||||
reports {
|
||||
xml.enabled = true // coveralls plugin depends on xml format report
|
||||
html.enabled = true
|
||||
}
|
||||
}
|
||||
|
||||
tasks.coveralls {
|
||||
dependsOn 'check'
|
||||
}
|
||||
@@ -1,11 +1,6 @@
|
||||
apply plugin: 'org.asciidoctor.convert'
|
||||
apply plugin: 'org.ajoberstar.github-pages'
|
||||
|
||||
//artifactoryPublish.skip=true
|
||||
sonarqube.skipProject=true
|
||||
|
||||
asciidoctor.dependsOn test
|
||||
|
||||
asciidoctor {
|
||||
sources {
|
||||
include 'index.adoc'
|
||||
@@ -19,28 +14,21 @@ asciidoctor {
|
||||
sectlinks: '',
|
||||
sectanchors: '',
|
||||
hardbreaks: '',
|
||||
'release-version': project.releaseVersion,
|
||||
'coreProjectDir': project(':swagger2markup').projectDir
|
||||
]
|
||||
}
|
||||
|
||||
publishGhPages.dependsOn asciidoctor
|
||||
|
||||
githubPages {
|
||||
githubPages {
|
||||
repoUri = 'https://github.com/Swagger2Markup/swagger2markup.git'
|
||||
|
||||
// use ENV GRGIT_USER
|
||||
// use ENV GRGIT_PASS
|
||||
// or org.ajoberstar.grgit.auth.username system property
|
||||
// org.ajoberstar.grgit.auth.password system property
|
||||
// see http://ajoberstar.org/grgit/grgit-authentication.html for details
|
||||
credentials {
|
||||
username = project.hasProperty('githubUser') ? project.githubUser : System.getenv('GITHUB_USER')
|
||||
password = project.hasProperty('githubPassword') ? project.githubPassword : System.getenv('GITHUB_PASSWORD')
|
||||
}
|
||||
|
||||
pages {
|
||||
from file(asciidoctor.outputDir.path + '/html5')
|
||||
into project.releaseVersion
|
||||
}
|
||||
}
|
||||
|
||||
pages {
|
||||
from file(asciidoctor.outputDir.path + '/html5')
|
||||
into project.version
|
||||
}
|
||||
}
|
||||
151
gradle/publishing.gradle
Normal file
@@ -0,0 +1,151 @@
|
||||
import java.text.SimpleDateFormat
|
||||
|
||||
apply plugin: 'maven-publish'
|
||||
apply plugin: 'com.jfrog.bintray'
|
||||
apply plugin: "com.jfrog.artifactory"
|
||||
|
||||
Date buildTimeAndDate = new Date()
|
||||
ext {
|
||||
buildDate = new SimpleDateFormat('yyyy-MM-dd').format(buildTimeAndDate)
|
||||
buildTime = new SimpleDateFormat('HH:mm:ss.SSSZ').format(buildTimeAndDate)
|
||||
projectUrl = 'https://github.com/Swagger2Markup/swagger2markup'
|
||||
licenseUrl = 'https://github.com/Swagger2Markup/swagger2markup/blob/master/LICENSE.txt'
|
||||
scmUrl = 'https://github.com/Swagger2Markup/swagger2markup.git'
|
||||
issuesUrl = 'https://github.com/Swagger2Markup/swagger2markup/issues'
|
||||
}
|
||||
|
||||
task sourcesJar(type: Jar, dependsOn: classes) {
|
||||
classifier = 'sources'
|
||||
from sourceSets.main.allSource
|
||||
}
|
||||
|
||||
task javadocJar(type: Jar, dependsOn: javadoc) {
|
||||
classifier = 'javadoc'
|
||||
from javadoc.destinationDir
|
||||
}
|
||||
|
||||
artifacts {
|
||||
archives sourcesJar
|
||||
archives javadocJar
|
||||
}
|
||||
|
||||
jar {
|
||||
manifest {
|
||||
attributes(
|
||||
'Created-By': System.properties['java.version'] + " (" + System.properties['java.vendor'] + " " + System.properties['java.vm.version'] + ")",
|
||||
'Built-With': "gradle-${project.getGradle().getGradleVersion()}, groovy-${GroovySystem.getVersion()}",
|
||||
'Build-Time': "${new Date().format("yyyy-MM-dd'T'HH:mm:ssZ")}",
|
||||
'Specification-Title': "${project.name}",
|
||||
'Specification-Version': project.version.toString(),
|
||||
'Implementation-Title': "${project.name}",
|
||||
'Implementation-Version': project.version.toString()
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
if (!project.hasProperty('bintrayUsername')) ext.bintrayUsername = ''
|
||||
if (!project.hasProperty('bintrayApiKey')) ext.bintrayApiKey = ''
|
||||
if (!project.hasProperty('gpgPassphrase')) ext.gpgPassphrase = ''
|
||||
if (!project.hasProperty('ossUser')) ext.ossUser = ''
|
||||
if (!project.hasProperty('ossPassword')) ext.ossPassword = ''
|
||||
|
||||
publishing {
|
||||
publications {
|
||||
mavenJava(MavenPublication) {
|
||||
from components.java
|
||||
pom.withXml {
|
||||
def devs = ['RobWin': 'Robert Winkler']
|
||||
def root = asNode()
|
||||
|
||||
root.dependencies.'*'.findAll() {
|
||||
it.scope.text() == 'runtime' && project.configurations.compile.allDependencies.find { dep ->
|
||||
dep.name == it.artifactId.text()
|
||||
}
|
||||
}.each() {
|
||||
it.scope*.value = 'compile'
|
||||
}
|
||||
|
||||
root.appendNode('name', project.name)
|
||||
root.appendNode('packaging', 'jar')
|
||||
root.appendNode('url', projectUrl)
|
||||
root.appendNode('description', project.description)
|
||||
|
||||
def license = root.appendNode('licenses').appendNode('license')
|
||||
license.appendNode('name', 'Apache-2.0')
|
||||
license.appendNode('url', licenseUrl)
|
||||
license.appendNode('distribution', 'repo')
|
||||
|
||||
root.appendNode('scm').appendNode('url', scmUrl)
|
||||
|
||||
def developers = root.appendNode('developers')
|
||||
devs.each {
|
||||
def d = developers.appendNode('developer')
|
||||
d.appendNode('id', it.key)
|
||||
d.appendNode('name', it.value)
|
||||
}
|
||||
}
|
||||
artifact sourcesJar
|
||||
artifact javadocJar
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
bintray {
|
||||
user = project.bintrayUsername
|
||||
key = project.bintrayApiKey
|
||||
dryRun = false //Whether to run this as dry-run, without deploying
|
||||
publish = true //If version should be auto published after an upload
|
||||
publications = ['mavenJava']
|
||||
pkg {
|
||||
repo = 'Maven'
|
||||
name = 'swagger2markup'
|
||||
userOrg = 'swagger2markup'
|
||||
websiteUrl = projectUrl
|
||||
issueTrackerUrl = issuesUrl
|
||||
vcsUrl = scmUrl
|
||||
desc = rootProject.description
|
||||
licenses = ['Apache-2.0']
|
||||
version {
|
||||
vcsTag = rootProject.version
|
||||
gpg {
|
||||
sign = true //Determines whether to GPG sign the files. The default is false
|
||||
passphrase = project.gpgPassphrase //Optional. The passphrase for GPG signing'
|
||||
}
|
||||
mavenCentralSync {
|
||||
sync = true //Optional (true by default). Determines whether to sync the version to Maven Central.
|
||||
user = ossUser //OSS user token
|
||||
password = ossPassword //OSS user password
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
artifactory {
|
||||
contextUrl = 'https://oss.jfrog.org'
|
||||
resolve {
|
||||
repository {
|
||||
repoKey = 'libs-release'
|
||||
}
|
||||
}
|
||||
publish {
|
||||
repository {
|
||||
repoKey = 'oss-snapshot-local' //The Artifactory repository key to publish to
|
||||
//when using oss.jfrog.org the credentials are from Bintray. For local build we expect them to be found in
|
||||
//~/.gradle/gradle.properties, otherwise to be set in the build server
|
||||
username = project.hasProperty('bintrayUsername') ? project.bintrayUsername : System.getenv('BINTRAY_USER')
|
||||
password = project.hasProperty('bintrayApiKey') ? project.bintrayApiKey : System.getenv('BINTRAY_KEY')
|
||||
}
|
||||
defaults {
|
||||
publications('mavenJava')
|
||||
}
|
||||
}
|
||||
if (System.properties['https.proxyHost']) {
|
||||
clientConfig.proxy.host = System.properties['https.proxyHost']
|
||||
clientConfig.proxy.port = System.properties['https.proxyPort'].toInteger()
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
tasks.artifactoryPublish {
|
||||
dependsOn 'check'
|
||||
}
|
||||
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
4
gradle/wrapper/gradle-wrapper.properties
vendored
@@ -1,6 +1,6 @@
|
||||
#Mon Oct 21 16:35:38 BST 2019
|
||||
#Thu Mar 31 16:29:35 CEST 2016
|
||||
distributionBase=GRADLE_USER_HOME
|
||||
distributionPath=wrapper/dists
|
||||
zipStoreBase=GRADLE_USER_HOME
|
||||
zipStorePath=wrapper/dists
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.3-all.zip
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-2.12-all.zip
|
||||
|
||||
100
gradlew
vendored
@@ -1,4 +1,4 @@
|
||||
#!/usr/bin/env sh
|
||||
#!/usr/bin/env bash
|
||||
|
||||
##############################################################################
|
||||
##
|
||||
@@ -6,6 +6,42 @@
|
||||
##
|
||||
##############################################################################
|
||||
|
||||
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||
DEFAULT_JVM_OPTS=""
|
||||
|
||||
APP_NAME="Gradle"
|
||||
APP_BASE_NAME=`basename "$0"`
|
||||
|
||||
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||
MAX_FD="maximum"
|
||||
|
||||
warn ( ) {
|
||||
echo "$*"
|
||||
}
|
||||
|
||||
die ( ) {
|
||||
echo
|
||||
echo "$*"
|
||||
echo
|
||||
exit 1
|
||||
}
|
||||
|
||||
# OS specific support (must be 'true' or 'false').
|
||||
cygwin=false
|
||||
msys=false
|
||||
darwin=false
|
||||
case "`uname`" in
|
||||
CYGWIN* )
|
||||
cygwin=true
|
||||
;;
|
||||
Darwin* )
|
||||
darwin=true
|
||||
;;
|
||||
MINGW* )
|
||||
msys=true
|
||||
;;
|
||||
esac
|
||||
|
||||
# Attempt to set APP_HOME
|
||||
# Resolve links: $0 may be a link
|
||||
PRG="$0"
|
||||
@@ -24,46 +60,6 @@ cd "`dirname \"$PRG\"`/" >/dev/null
|
||||
APP_HOME="`pwd -P`"
|
||||
cd "$SAVED" >/dev/null
|
||||
|
||||
APP_NAME="Gradle"
|
||||
APP_BASE_NAME=`basename "$0"`
|
||||
|
||||
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||
DEFAULT_JVM_OPTS=""
|
||||
|
||||
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||
MAX_FD="maximum"
|
||||
|
||||
warn () {
|
||||
echo "$*"
|
||||
}
|
||||
|
||||
die () {
|
||||
echo
|
||||
echo "$*"
|
||||
echo
|
||||
exit 1
|
||||
}
|
||||
|
||||
# OS specific support (must be 'true' or 'false').
|
||||
cygwin=false
|
||||
msys=false
|
||||
darwin=false
|
||||
nonstop=false
|
||||
case "`uname`" in
|
||||
CYGWIN* )
|
||||
cygwin=true
|
||||
;;
|
||||
Darwin* )
|
||||
darwin=true
|
||||
;;
|
||||
MINGW* )
|
||||
msys=true
|
||||
;;
|
||||
NONSTOP* )
|
||||
nonstop=true
|
||||
;;
|
||||
esac
|
||||
|
||||
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
|
||||
|
||||
# Determine the Java command to use to start the JVM.
|
||||
@@ -89,7 +85,7 @@ location of your Java installation."
|
||||
fi
|
||||
|
||||
# Increase the maximum file descriptors if we can.
|
||||
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
|
||||
if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then
|
||||
MAX_FD_LIMIT=`ulimit -H -n`
|
||||
if [ $? -eq 0 ] ; then
|
||||
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
|
||||
@@ -154,19 +150,11 @@ if $cygwin ; then
|
||||
esac
|
||||
fi
|
||||
|
||||
# Escape application args
|
||||
save () {
|
||||
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
|
||||
echo " "
|
||||
# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
|
||||
function splitJvmOpts() {
|
||||
JVM_OPTS=("$@")
|
||||
}
|
||||
APP_ARGS=$(save "$@")
|
||||
eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
|
||||
JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
|
||||
|
||||
# Collect all arguments for the java command, following the shell quoting and substitution rules
|
||||
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
|
||||
|
||||
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
|
||||
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
|
||||
cd "$(dirname "$0")"
|
||||
fi
|
||||
|
||||
exec "$JAVACMD" "$@"
|
||||
exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"
|
||||
|
||||
14
gradlew.bat
vendored
@@ -8,14 +8,14 @@
|
||||
@rem Set local scope for the variables with windows NT shell
|
||||
if "%OS%"=="Windows_NT" setlocal
|
||||
|
||||
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||
set DEFAULT_JVM_OPTS=
|
||||
|
||||
set DIRNAME=%~dp0
|
||||
if "%DIRNAME%" == "" set DIRNAME=.
|
||||
set APP_BASE_NAME=%~n0
|
||||
set APP_HOME=%DIRNAME%
|
||||
|
||||
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||
set DEFAULT_JVM_OPTS=
|
||||
|
||||
@rem Find java.exe
|
||||
if defined JAVA_HOME goto findJavaFromJavaHome
|
||||
|
||||
@@ -46,9 +46,10 @@ echo location of your Java installation.
|
||||
goto fail
|
||||
|
||||
:init
|
||||
@rem Get command-line arguments, handling Windows variants
|
||||
@rem Get command-line arguments, handling Windowz variants
|
||||
|
||||
if not "%OS%" == "Windows_NT" goto win9xME_args
|
||||
if "%@eval[2+2]" == "4" goto 4NT_args
|
||||
|
||||
:win9xME_args
|
||||
@rem Slurp the command line arguments.
|
||||
@@ -59,6 +60,11 @@ set _SKIP=2
|
||||
if "x%~1" == "x" goto execute
|
||||
|
||||
set CMD_LINE_ARGS=%*
|
||||
goto execute
|
||||
|
||||
:4NT_args
|
||||
@rem Get arguments from the 4NT Shell from JP Software
|
||||
set CMD_LINE_ARGS=%$
|
||||
|
||||
:execute
|
||||
@rem Setup the command line
|
||||
|
||||
@@ -1,52 +0,0 @@
|
||||
// Allows centralized definition of the version of artifacts to
|
||||
// use. In that respect it serves a role similar to <dependencyManagement> in Maven
|
||||
ext {
|
||||
implLibraries = [:]
|
||||
testLibraries = [:]
|
||||
dependencyOverrides = [:]
|
||||
}
|
||||
implLibraries = [
|
||||
asciiDocJApi : "org.asciidoctor:asciidoctorj-api:2.2.0",
|
||||
commonsBeanUtils : "commons-beanutils:commons-beanutils:1.9.4",
|
||||
commonsCodec : "commons-codec:commons-codec:1.13",
|
||||
commonsCollections4: "org.apache.commons:commons-collections4:4.4",
|
||||
commonsConf2 : "org.apache.commons:commons-configuration2:2.6",
|
||||
commonsLang3 : "org.apache.commons:commons-lang3:3.9",
|
||||
commonsIO : "commons-io:commons-io:2.6",
|
||||
commonsText : "org.apache.commons:commons-text:1.8",
|
||||
guava : 'com.google.guava:guava:27.0.1-android',
|
||||
jacksonDatabind : 'com.fasterxml.jackson.core:jackson-databind:2.9.10',
|
||||
mark2Ascii : "nl.jworks.markdown_to_asciidoc:markdown_to_asciidoc:1.1",
|
||||
paleo : "ch.netzwerg:paleo-core:0.14.0",
|
||||
pegdown : "org.pegdown:pegdown:1.6.0",
|
||||
slf4j : "org.slf4j:slf4j-api:1.7.28",
|
||||
swaggerV2 : "io.swagger:swagger-parser:1.0.47",
|
||||
swaggerV2Converter : "io.swagger.parser.v3:swagger-parser-v2-converter:2.0.15",
|
||||
swaggerV3 : "io.swagger.parser.v3:swagger-parser:2.0.15",
|
||||
vavr : "io.vavr:vavr:0.10.2"
|
||||
]
|
||||
|
||||
testLibraries = [
|
||||
asciiDocJ : "org.asciidoctor:asciidoctorj:2.2.0",
|
||||
assertj : "org.assertj:assertj-core:3.13.2",
|
||||
assertjDiff: "io.github.robwin:assertj-diff:0.1.1",
|
||||
junit : "junit:junit:4.12",
|
||||
logback : "ch.qos.logback:logback-classic:1.2.3",
|
||||
mockito : "org.mockito:mockito-core:3.1.0"
|
||||
]
|
||||
|
||||
dependencyOverrides = [
|
||||
assertj : testLibraries.assertj,
|
||||
commonsCodec : implLibraries.commonsCodec,
|
||||
commonsIO : implLibraries.commonsIO,
|
||||
commonsLang3 : implLibraries.commonsLang3,
|
||||
findBugs : 'com.google.code.findbugs:jsr305:3.0.2',
|
||||
guava : implLibraries.guava,
|
||||
jaksonCore : 'com.github.fge:jackson-coreutils:1.8',
|
||||
jacksonDatabind: implLibraries.jacksonDatabind,
|
||||
jnrConstants : 'com.github.jnr:jnr-constants:0.9.12',
|
||||
jnrEnxio : 'com.github.jnr:jnr-enxio:0.19',
|
||||
jnrPosix : 'com.github.jnr:jnr-posix:3.0.49',
|
||||
jodaTime : 'joda-time:joda-time:2.9.9',
|
||||
slf4j : implLibraries.slf4j,
|
||||
]
|
||||
@@ -1,34 +0,0 @@
|
||||
ext.moduleName="io.github.swagger2markup.openapi2markup"
|
||||
|
||||
dependencies {
|
||||
configurations.all {
|
||||
resolutionStrategy.force dependencyOverrides.commonsCodec
|
||||
resolutionStrategy.force dependencyOverrides.commonsIO
|
||||
resolutionStrategy.force dependencyOverrides.commonsLang3
|
||||
resolutionStrategy.force dependencyOverrides.jnrConstants
|
||||
resolutionStrategy.force dependencyOverrides.jnrEnxio
|
||||
resolutionStrategy.force dependencyOverrides.jnrPosix
|
||||
resolutionStrategy.force dependencyOverrides.jodaTime
|
||||
resolutionStrategy.force dependencyOverrides.slf4j
|
||||
resolutionStrategy.force dependencyOverrides.jacksonDatabind
|
||||
resolutionStrategy.force dependencyOverrides.guava
|
||||
resolutionStrategy.force dependencyOverrides.findBugs
|
||||
resolutionStrategy.force dependencyOverrides.jaksonCore
|
||||
resolutionStrategy.force dependencyOverrides.assertj
|
||||
}
|
||||
// implementation implLibraries.swaggerV2Converter
|
||||
compile project(':swagger2markup-asciidoc')
|
||||
compile project(':swagger2markup-core')
|
||||
implementation implLibraries.asciiDocJApi
|
||||
implementation implLibraries.commonsText
|
||||
implementation implLibraries.commonsBeanUtils
|
||||
implementation implLibraries.slf4j
|
||||
implementation implLibraries.swaggerV3
|
||||
implementation implLibraries.commonsCollections4
|
||||
implementation implLibraries.commonsConf2
|
||||
implementation implLibraries.vavr
|
||||
testImplementation testLibraries.assertj
|
||||
testImplementation testLibraries.assertjDiff
|
||||
testImplementation testLibraries.junit
|
||||
testImplementation testLibraries.logback
|
||||
}
|
||||
@@ -1,378 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup;
|
||||
|
||||
import io.github.swagger2markup.adoc.ast.impl.DocumentImpl;
|
||||
import io.github.swagger2markup.config.OpenAPILabels;
|
||||
import io.github.swagger2markup.config.builder.OpenAPI2MarkupConfigBuilder;
|
||||
import io.github.swagger2markup.extension.OpenAPI2MarkupExtensionRegistry;
|
||||
import io.github.swagger2markup.extension.builder.OpenAPI2MarkupExtensionRegistryBuilder;
|
||||
import io.github.swagger2markup.internal.document.ComponentsDocument;
|
||||
import io.github.swagger2markup.internal.document.OverviewDocument;
|
||||
import io.github.swagger2markup.internal.document.PathsDocument;
|
||||
import io.github.swagger2markup.internal.document.SecurityDocument;
|
||||
import io.github.swagger2markup.utils.URIUtils;
|
||||
import io.swagger.v3.oas.models.OpenAPI;
|
||||
import io.swagger.v3.parser.OpenAPIV3Parser;
|
||||
import org.apache.commons.io.IOUtils;
|
||||
import org.apache.commons.lang3.Validate;
|
||||
import org.asciidoctor.ast.Document;
|
||||
|
||||
import java.io.BufferedWriter;
|
||||
import java.io.IOException;
|
||||
import java.io.Reader;
|
||||
import java.io.StringReader;
|
||||
import java.net.MalformedURLException;
|
||||
import java.net.URI;
|
||||
import java.net.URISyntaxException;
|
||||
import java.net.URL;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Path;
|
||||
import java.nio.file.Paths;
|
||||
|
||||
public class OpenAPI2MarkupConverter extends AbstractSchema2MarkupConverter<OpenAPI> {
|
||||
private final OverviewDocument overviewDocument;
|
||||
private final PathsDocument pathsDocument;
|
||||
private final ComponentsDocument componentsDocument;
|
||||
private final SecurityDocument securityDocument;
|
||||
private final OpenAPIContext openAPIContext;
|
||||
|
||||
|
||||
public OpenAPI2MarkupConverter(OpenAPIContext context) {
|
||||
super(context);
|
||||
this.openAPIContext = context;
|
||||
this.overviewDocument = new OverviewDocument(context);
|
||||
this.pathsDocument = new PathsDocument(context);
|
||||
this.componentsDocument = new ComponentsDocument(context);
|
||||
this.securityDocument = new SecurityDocument(context);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Creates a OpenAPI2MarkupConverter.Builder from a URI.
|
||||
*
|
||||
* @param swaggerUri the URI
|
||||
* @return a OpenAPI2MarkupConverter
|
||||
*/
|
||||
public static Builder from(URI swaggerUri) {
|
||||
Validate.notNull(swaggerUri, "swaggerUri must not be null");
|
||||
String scheme = swaggerUri.getScheme();
|
||||
if (scheme != null && swaggerUri.getScheme().startsWith("http")) {
|
||||
try {
|
||||
return from(swaggerUri.toURL());
|
||||
} catch (MalformedURLException e) {
|
||||
throw new RuntimeException("Failed to convert URI to URL", e);
|
||||
}
|
||||
} else if (scheme != null && swaggerUri.getScheme().startsWith("file")) {
|
||||
return from(Paths.get(swaggerUri));
|
||||
} else {
|
||||
return from(URIUtils.convertUriWithoutSchemeToFileScheme(swaggerUri));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a OpenAPI2MarkupConverter.Builder using a remote URL.
|
||||
*
|
||||
* @param swaggerURL the remote URL
|
||||
* @return a OpenAPI2MarkupConverter
|
||||
*/
|
||||
public static Builder from(URL swaggerURL) {
|
||||
Validate.notNull(swaggerURL, "swaggerURL must not be null");
|
||||
return new Builder(swaggerURL);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a OpenAPI2MarkupConverter.Builder using a local Path.
|
||||
*
|
||||
* @param swaggerPath the local Path
|
||||
* @return a OpenAPI2MarkupConverter
|
||||
*/
|
||||
public static Builder from(Path swaggerPath) {
|
||||
Validate.notNull(swaggerPath, "swaggerPath must not be null");
|
||||
if (Files.notExists(swaggerPath)) {
|
||||
throw new IllegalArgumentException(String.format("swaggerPath does not exist: %s", swaggerPath));
|
||||
}
|
||||
try {
|
||||
if (Files.isHidden(swaggerPath)) {
|
||||
throw new IllegalArgumentException("swaggerPath must not be a hidden file");
|
||||
}
|
||||
} catch (IOException e) {
|
||||
throw new RuntimeException("Failed to check if swaggerPath is a hidden file", e);
|
||||
}
|
||||
return new Builder(swaggerPath);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a OpenAPI2MarkupConverter.Builder from a given Swagger model.
|
||||
*
|
||||
* @param openAPI the Swagger source.
|
||||
* @return a OpenAPI2MarkupConverter
|
||||
*/
|
||||
public static Builder from(OpenAPI openAPI) {
|
||||
Validate.notNull(openAPI, "schema must not be null");
|
||||
return new Builder(openAPI);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a OpenAPI2MarkupConverter.Builder from a given Swagger YAML or JSON String.
|
||||
*
|
||||
* @param swaggerString the Swagger YAML or JSON String.
|
||||
* @return a OpenAPI2MarkupConverter
|
||||
*/
|
||||
public static Builder from(String swaggerString) {
|
||||
Validate.notEmpty(swaggerString, "swaggerString must not be null");
|
||||
return from(new StringReader(swaggerString));
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a OpenAPI2MarkupConverter.Builder from a given Swagger YAML or JSON reader.
|
||||
*
|
||||
* @param schemaReader the schema YAML or JSON reader.
|
||||
* @return a OpenAPI2MarkupConverter
|
||||
*/
|
||||
public static Builder from(Reader schemaReader) {
|
||||
Validate.notNull(schemaReader, "swaggerReader must not be null");
|
||||
OpenAPI openAPI;
|
||||
try {
|
||||
//TODO
|
||||
openAPI = new OpenAPIV3Parser().read(IOUtils.toString(schemaReader));
|
||||
} catch (IOException e) {
|
||||
throw new RuntimeException("Swagger source can not be parsed", e);
|
||||
}
|
||||
if (openAPI == null)
|
||||
throw new IllegalArgumentException("Swagger source is in a wrong format");
|
||||
|
||||
return new Builder(openAPI);
|
||||
}
|
||||
|
||||
|
||||
@Override
|
||||
public void toFolder(Path outputDirectory) {
|
||||
Validate.notNull(outputDirectory, "outputDirectory must not be null");
|
||||
openAPIContext.setOutputPath(outputDirectory);
|
||||
writeToFile(applyOverviewDocument(), outputDirectory.resolve(openAPIContext.config.getOverviewDocument()));
|
||||
writeToFile(applyPathsDocument(), outputDirectory.resolve(openAPIContext.config.getPathsDocument()));
|
||||
writeToFile(applyComponentsDocument(), outputDirectory.resolve(openAPIContext.config.getDefinitionsDocument()));
|
||||
writeToFile(applySecurityDocument(), outputDirectory.resolve(openAPIContext.config.getSecurityDocument()));
|
||||
}
|
||||
|
||||
@Override
|
||||
public void toFile(Path outputFile) {
|
||||
Validate.notNull(outputFile, "outputFile must not be null");
|
||||
|
||||
writeToFile(applyOverviewDocument(), outputFile);
|
||||
writeToFile(applyPathsDocument(), outputFile);
|
||||
writeToFile(applyComponentsDocument(), outputFile);
|
||||
writeToFile(applySecurityDocument(), outputFile);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void toFileWithoutExtension(Path outputFile) {
|
||||
Validate.notNull(outputFile, "outputFile must not be null");
|
||||
|
||||
writeToFileWithoutExtension(applyOverviewDocument(), outputFile);
|
||||
writeToFileWithoutExtension(applyPathsDocument(), outputFile);
|
||||
writeToFileWithoutExtension(applyComponentsDocument(), outputFile);
|
||||
writeToFileWithoutExtension(applySecurityDocument(), outputFile);
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return applyOverviewDocument().convert() +
|
||||
applyPathsDocument().convert() +
|
||||
applyComponentsDocument().convert() +
|
||||
applySecurityDocument().convert();
|
||||
}
|
||||
|
||||
private Document applyOverviewDocument() {
|
||||
return overviewDocument.apply(
|
||||
openAPIContext.createDocument(),
|
||||
OverviewDocument.parameters(openAPIContext.getSchema()));
|
||||
}
|
||||
|
||||
private Document applyPathsDocument() {
|
||||
return pathsDocument.apply(
|
||||
openAPIContext.createDocument(),
|
||||
PathsDocument.parameters(openAPIContext.getSchema()));
|
||||
}
|
||||
|
||||
private Document applyComponentsDocument() {
|
||||
return componentsDocument.apply(
|
||||
openAPIContext.createDocument(),
|
||||
ComponentsDocument.parameters(openAPIContext.getSchema().getComponents()));
|
||||
}
|
||||
|
||||
private Document applySecurityDocument() {
|
||||
return securityDocument.apply(
|
||||
openAPIContext.createDocument(),
|
||||
SecurityDocument.parameters(openAPIContext.getSchema()));
|
||||
}
|
||||
|
||||
private void writeToFile(Document document, Path path) {
|
||||
MarkupLanguage markupLanguage = openAPIContext.config.getMarkupLanguage();
|
||||
if (isMarkupLanguageSupported(markupLanguage)) {
|
||||
String fileExtension = markupLanguage.getFileNameExtensions().get(0);
|
||||
writeToFileWithoutExtension(document, path.resolveSibling(path.getFileName().toString() + fileExtension));
|
||||
} else {
|
||||
throw new RuntimeException("Given Markup language '"+markupLanguage+"' is not supported by "+getClass().getName());
|
||||
}
|
||||
}
|
||||
|
||||
private boolean isMarkupLanguageSupported(MarkupLanguage markupLanguage) {
|
||||
return markupLanguage == MarkupLanguage.ASCIIDOC;
|
||||
}
|
||||
|
||||
private void writeToFileWithoutExtension(Document document, Path file) {
|
||||
if (file.getParent() != null) {
|
||||
try {
|
||||
Files.createDirectories(file.getParent());
|
||||
} catch (IOException e) {
|
||||
throw new RuntimeException("Failed create directory", e);
|
||||
}
|
||||
}
|
||||
try (BufferedWriter writer = Files.newBufferedWriter(file, StandardCharsets.UTF_8)) {
|
||||
writer.write(document.convert());
|
||||
} catch (IOException e) {
|
||||
throw new RuntimeException("Failed to write file", e);
|
||||
}
|
||||
if (logger.isInfoEnabled()) {
|
||||
logger.info("Markup document written to: {}", file);
|
||||
}
|
||||
}
|
||||
|
||||
public static class OpenAPIContext extends Context<OpenAPI> {
|
||||
private OpenSchema2MarkupConfig config;
|
||||
private OpenAPI2MarkupExtensionRegistry extensionRegistry;
|
||||
|
||||
public OpenAPIContext(OpenSchema2MarkupConfig config,
|
||||
OpenAPI2MarkupExtensionRegistry extensionRegistry,
|
||||
OpenAPI schema, URI swaggerLocation, Labels labels) {
|
||||
super(config, extensionRegistry, schema, swaggerLocation, labels);
|
||||
this.config = config;
|
||||
this.extensionRegistry = extensionRegistry;
|
||||
}
|
||||
|
||||
@Override
|
||||
public OpenSchema2MarkupConfig getConfig() {
|
||||
return config;
|
||||
}
|
||||
|
||||
@Override
|
||||
public OpenAPI2MarkupExtensionRegistry getExtensionRegistry() {
|
||||
return extensionRegistry;
|
||||
}
|
||||
|
||||
public Document createDocument() {
|
||||
return new DocumentImpl();
|
||||
}
|
||||
}
|
||||
|
||||
public static class Builder {
|
||||
private final OpenAPI openAPI;
|
||||
private final URI schemaLocation;
|
||||
private OpenSchema2MarkupConfig config;
|
||||
private OpenAPI2MarkupExtensionRegistry extensionRegistry;
|
||||
|
||||
/**
|
||||
* Creates a Builder from a remote URL.
|
||||
*
|
||||
* @param schemaUrl the remote URL
|
||||
*/
|
||||
Builder(URL schemaUrl) {
|
||||
try {
|
||||
this.schemaLocation = schemaUrl.toURI();
|
||||
} catch (URISyntaxException e) {
|
||||
throw new IllegalArgumentException("swaggerURL is in a wrong format", e);
|
||||
}
|
||||
this.openAPI = readSchema(schemaUrl.toString());
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a Builder from a local Path.
|
||||
*
|
||||
* @param swaggerPath the local Path
|
||||
*/
|
||||
Builder(Path swaggerPath) {
|
||||
this.schemaLocation = swaggerPath.toAbsolutePath().toUri();
|
||||
this.openAPI = readSchema(swaggerPath.toString());
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a Builder using a given Swagger model.
|
||||
*
|
||||
* @param openAPI the Swagger source.
|
||||
*/
|
||||
Builder(OpenAPI openAPI) {
|
||||
this.openAPI = openAPI;
|
||||
this.schemaLocation = null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Uses the SwaggerParser to read the Swagger source.
|
||||
*
|
||||
* @param schemaLocation the location of the Swagger source
|
||||
* @return the Swagger model
|
||||
*/
|
||||
private OpenAPI readSchema(String schemaLocation) {
|
||||
OpenAPI openAPI = new OpenAPIV3Parser().read(schemaLocation);
|
||||
if (openAPI == null) {
|
||||
throw new IllegalArgumentException("Failed to read the schema");
|
||||
}
|
||||
return openAPI;
|
||||
}
|
||||
|
||||
public Builder withConfig(OpenSchema2MarkupConfig config) {
|
||||
Validate.notNull(config, "config must not be null");
|
||||
this.config = config;
|
||||
return this;
|
||||
}
|
||||
|
||||
public Builder withExtensionRegistry(OpenAPI2MarkupExtensionRegistry registry) {
|
||||
Validate.notNull(registry, "registry must not be null");
|
||||
this.extensionRegistry = registry;
|
||||
return this;
|
||||
}
|
||||
|
||||
public OpenAPI2MarkupConverter build() {
|
||||
if (config == null)
|
||||
config = new OpenAPI2MarkupConfigBuilder().build();
|
||||
|
||||
if (extensionRegistry == null)
|
||||
extensionRegistry = new OpenAPI2MarkupExtensionRegistryBuilder().build();
|
||||
OpenAPILabels openApiLabels = new OpenAPILabels(config);
|
||||
OpenAPIContext context = new OpenAPIContext(config, extensionRegistry, openAPI, schemaLocation, openApiLabels);
|
||||
|
||||
initExtensions(context);
|
||||
|
||||
applySwaggerExtensions(context);
|
||||
|
||||
return new OpenAPI2MarkupConverter(context);
|
||||
}
|
||||
|
||||
private void initExtensions(OpenAPIContext context) {
|
||||
extensionRegistry.getSwaggerModelExtensions().forEach(extension -> extension.setGlobalContext(context));
|
||||
extensionRegistry.getOverviewDocumentExtensions().forEach(extension -> extension.setGlobalContext(context));
|
||||
extensionRegistry.getDefinitionsDocumentExtensions().forEach(extension -> extension.setGlobalContext(context));
|
||||
extensionRegistry.getPathsDocumentExtensions().forEach(extension -> extension.setGlobalContext(context));
|
||||
extensionRegistry.getSecurityDocumentExtensions().forEach(extension -> extension.setGlobalContext(context));
|
||||
}
|
||||
|
||||
private void applySwaggerExtensions(OpenAPIContext context) {
|
||||
extensionRegistry.getSwaggerModelExtensions().forEach(extension -> extension.apply(context.getSchema()));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,36 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup;
|
||||
|
||||
import org.apache.commons.configuration2.Configuration;
|
||||
|
||||
import java.util.Map;
|
||||
import java.util.Properties;
|
||||
|
||||
public class OpenAPI2MarkupProperties extends Schema2MarkupProperties {
|
||||
|
||||
public OpenAPI2MarkupProperties(Properties properties) {
|
||||
super(properties);
|
||||
}
|
||||
|
||||
public OpenAPI2MarkupProperties(Map<String, String> map) {
|
||||
super(map);
|
||||
}
|
||||
|
||||
public OpenAPI2MarkupProperties(Configuration configuration) {
|
||||
super(configuration);
|
||||
}
|
||||
}
|
||||
@@ -1,7 +0,0 @@
|
||||
package io.github.swagger2markup;
|
||||
|
||||
import io.github.swagger2markup.config.builder.Schema2MarkupConfigBuilder;
|
||||
|
||||
public class OpenSchema2MarkupConfig extends Schema2MarkupConfigBuilder.DefaultSchema2MarkupConfig {
|
||||
|
||||
}
|
||||
@@ -1,72 +0,0 @@
|
||||
package io.github.swagger2markup.config;
|
||||
|
||||
import io.github.swagger2markup.Labels;
|
||||
import io.github.swagger2markup.OpenSchema2MarkupConfig;
|
||||
|
||||
import java.util.ResourceBundle;
|
||||
|
||||
public class OpenAPILabels extends Labels {
|
||||
|
||||
public static final String LABEL_CONTENT = "label_content";
|
||||
public static final String LABEL_DEFAULT = "label_default";
|
||||
public static final String LABEL_DEPRECATED = "label_deprecated";
|
||||
public static final String LABEL_EXAMPLE = "label_example";
|
||||
public static final String LABEL_EXAMPLES = "label_examples";
|
||||
public static final String LABEL_EXCLUSIVE_MAXIMUM = "label_exclusive_maximum";
|
||||
public static final String LABEL_EXCLUSIVE_MINIMUM = "label_exclusive_minimum";
|
||||
public static final String LABEL_EXTERNAL_VALUE = "label_external_value";
|
||||
public static final String LABEL_FORMAT = "label_format";
|
||||
public static final String LABEL_MAXIMUM = "label_maximum";
|
||||
public static final String LABEL_MAX_ITEMS = "label_max_items";
|
||||
public static final String LABEL_MAX_LENGTH = "label_max_length";
|
||||
public static final String LABEL_MAX_PROPERTIES = "label_max_properties";
|
||||
public static final String LABEL_MINIMUM = "label_minimum";
|
||||
public static final String LABEL_MIN_ITEMS = "label_min_items";
|
||||
public static final String LABEL_MIN_LENGTH = "label_min_length";
|
||||
public static final String LABEL_MIN_PROPERTIES = "label_min_properties";
|
||||
public static final String LABEL_MULTIPLE_OF = "label_multiple_of";
|
||||
public static final String LABEL_NO_LINKS = "label_no_links";
|
||||
public static final String LABEL_NULLABLE = "label_nullable";
|
||||
public static final String LABEL_OPERATION = "label_operation";
|
||||
public static final String LABEL_OPTIONAL = "label_optional";
|
||||
public static final String LABEL_PARAMETERS = "label_parameters";
|
||||
public static final String LABEL_READ_ONLY = "label_read_only";
|
||||
public static final String LABEL_REQUIRED = "label_required";
|
||||
public static final String LABEL_SERVER = "label_server";
|
||||
public static final String LABEL_TERMS_OF_SERVICE = "label_terms_of_service";
|
||||
public static final String LABEL_TITLE = "label_title";
|
||||
public static final String LABEL_TYPE = "label_type";
|
||||
public static final String LABEL_UNIQUE_ITEMS = "label_unique_items";
|
||||
public static final String LABEL_WRITE_ONLY = "label_write_only";
|
||||
public static final String SECTION_TITLE_COMPONENTS = "section_title_components";
|
||||
public static final String SECTION_TITLE_PARAMETERS = "section_title_parameters";
|
||||
public static final String SECTION_TITLE_PATHS = "section_title_paths";
|
||||
public static final String SECTION_TITLE_SCHEMAS = "section_title_schemas";
|
||||
public static final String SECTION_TITLE_SECURITY = "section_title_security";
|
||||
public static final String SECTION_TITLE_SERVERS = "section_title_servers";
|
||||
public static final String SECTION_TITLE_OVERVIEW = "section_title_overview";
|
||||
public static final String SECTION_TITLE_TAGS = "section_title_tags";
|
||||
public static final String SECTION_TITLE_RESPONSES = "section_title_responses";
|
||||
public static final String SECTION_TITLE_HEADERS = "section_title_headers";
|
||||
public static final String SECTION_TITLE_LINKS = "section_title_links";
|
||||
public static final String TABLE_HEADER_DEFAULT = "table_header_default";
|
||||
public static final String TABLE_HEADER_DESCRIPTION = "table_header_description";
|
||||
public static final String TABLE_HEADER_HTTP_CODE = "table_header_http_code";
|
||||
public static final String TABLE_HEADER_LINKS = "table_header_links";
|
||||
public static final String TABLE_HEADER_NAME = "table_header_name";
|
||||
public static final String TABLE_HEADER_POSSIBLE_VALUES = "table_header_possible_values";
|
||||
public static final String TABLE_HEADER_SCHEMA = "table_header_schema";
|
||||
public static final String TABLE_HEADER_SCOPES = "table_header_scopes";
|
||||
public static final String TABLE_HEADER_TYPE = "table_header_type";
|
||||
public static final String TABLE_HEADER_VARIABLE = "table_header_variable";
|
||||
public static final String TABLE_TITLE_HEADERS = "table_title_headers";
|
||||
public static final String TABLE_TITLE_PARAMETERS = "table_title_parameters";
|
||||
public static final String TABLE_TITLE_PROPERTIES = "table_title_properties";
|
||||
public static final String TABLE_TITLE_RESPONSES = "table_title_responses";
|
||||
public static final String TABLE_TITLE_SECURITY = "table_title_security";
|
||||
public static final String TABLE_TITLE_SERVER_VARIABLES = "table_title_server_variables";
|
||||
|
||||
public OpenAPILabels(OpenSchema2MarkupConfig config) {
|
||||
super(ResourceBundle.getBundle("io/github/swagger2markup/lang/labels", config.getLanguage().toLocale()));
|
||||
}
|
||||
}
|
||||
@@ -1,38 +0,0 @@
|
||||
package io.github.swagger2markup.config.builder;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupProperties;
|
||||
import io.github.swagger2markup.OpenSchema2MarkupConfig;
|
||||
import org.apache.commons.configuration2.Configuration;
|
||||
import org.apache.commons.configuration2.ConfigurationConverter;
|
||||
import org.apache.commons.configuration2.MapConfiguration;
|
||||
import org.apache.commons.configuration2.PropertiesConfiguration;
|
||||
|
||||
import java.util.Map;
|
||||
import java.util.Properties;
|
||||
|
||||
public class OpenAPI2MarkupConfigBuilder extends Schema2MarkupConfigBuilder<OpenAPI2MarkupConfigBuilder, OpenSchema2MarkupConfig> {
|
||||
|
||||
public OpenAPI2MarkupConfigBuilder() {
|
||||
this(new PropertiesConfiguration());
|
||||
}
|
||||
|
||||
public OpenAPI2MarkupConfigBuilder(Properties properties) {
|
||||
this(ConfigurationConverter.getConfiguration(properties));
|
||||
}
|
||||
|
||||
public OpenAPI2MarkupConfigBuilder(Map<String, String> map) {
|
||||
this(new MapConfiguration(map));
|
||||
}
|
||||
|
||||
private OpenAPI2MarkupConfigBuilder(Configuration configuration) {
|
||||
super(OpenAPI2MarkupConfigBuilder.class,
|
||||
new OpenSchema2MarkupConfig(),
|
||||
new OpenAPI2MarkupProperties(getCompositeConfiguration(configuration)), configuration);
|
||||
}
|
||||
|
||||
@Override
|
||||
public OpenSchema2MarkupConfig build() {
|
||||
buildNaturalOrdering();
|
||||
return config;
|
||||
}
|
||||
}
|
||||
@@ -1,36 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package io.github.swagger2markup.extension;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter.OpenAPIContext;
|
||||
|
||||
/**
|
||||
* An abstract OpenAPI extension which must be extended by an other OpenAPI extensions
|
||||
*/
|
||||
abstract class AbstractExtension implements Extension {
|
||||
|
||||
protected OpenAPIContext globalContext;
|
||||
|
||||
/**
|
||||
* Global context lazy initialization
|
||||
*
|
||||
* @param globalContext Global context
|
||||
*/
|
||||
public void setGlobalContext(OpenAPIContext globalContext) {
|
||||
this.globalContext = globalContext;
|
||||
}
|
||||
}
|
||||
@@ -1,15 +0,0 @@
|
||||
package io.github.swagger2markup.extension;
|
||||
|
||||
import org.asciidoctor.ast.Document;
|
||||
|
||||
public class ContentContext {
|
||||
private Document document;
|
||||
|
||||
public ContentContext(Document document) {
|
||||
this.document = document;
|
||||
}
|
||||
|
||||
public Document getDocument() {
|
||||
return document;
|
||||
}
|
||||
}
|
||||
@@ -1,94 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package io.github.swagger2markup.extension;
|
||||
|
||||
import io.swagger.models.Model;
|
||||
import org.apache.commons.lang3.Validate;
|
||||
import org.asciidoctor.ast.Document;
|
||||
|
||||
import java.util.Optional;
|
||||
|
||||
/**
|
||||
* DefinitionsDocumentExtension extension point can be used to extend the definitions document content.
|
||||
*/
|
||||
public abstract class DefinitionsDocumentExtension extends AbstractExtension {
|
||||
|
||||
|
||||
public abstract void apply(Context context);
|
||||
|
||||
public enum Position {
|
||||
DOCUMENT_BEFORE,
|
||||
DOCUMENT_BEGIN,
|
||||
DOCUMENT_END,
|
||||
DOCUMENT_AFTER,
|
||||
DEFINITION_BEFORE,
|
||||
DEFINITION_BEGIN,
|
||||
DEFINITION_END,
|
||||
DEFINITION_AFTER
|
||||
}
|
||||
|
||||
public static class Context extends ContentContext {
|
||||
private Position position;
|
||||
/**
|
||||
* null if position == DOCUMENT_*
|
||||
*/
|
||||
private String definitionName;
|
||||
|
||||
/**
|
||||
* null if position == DOCUMENT_*
|
||||
*/
|
||||
private Model model;
|
||||
|
||||
/**
|
||||
* @param position the current position
|
||||
* @param document document object
|
||||
*/
|
||||
public Context(Position position, Document document) {
|
||||
super(document);
|
||||
Validate.inclusiveBetween(Position.DOCUMENT_BEFORE, Position.DOCUMENT_AFTER, position);
|
||||
this.position = position;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param position the current position
|
||||
* @param document document object
|
||||
* @param definitionName the name of the current definition
|
||||
* @param model the current Model of the definition
|
||||
*/
|
||||
public Context(Position position, Document document, String definitionName, Model model) {
|
||||
super(document);
|
||||
Validate.inclusiveBetween(Position.DEFINITION_BEFORE, Position.DEFINITION_AFTER, position);
|
||||
Validate.notNull(definitionName);
|
||||
Validate.notNull(model);
|
||||
this.position = position;
|
||||
this.definitionName = definitionName;
|
||||
this.model = model;
|
||||
}
|
||||
|
||||
public Position getPosition() {
|
||||
return position;
|
||||
}
|
||||
|
||||
public Optional<String> getDefinitionName() {
|
||||
return Optional.ofNullable(definitionName);
|
||||
}
|
||||
|
||||
public Optional<Model> getModel() {
|
||||
return Optional.ofNullable(model);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,33 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package io.github.swagger2markup.extension;
|
||||
|
||||
import static io.github.swagger2markup.OpenAPI2MarkupConverter.OpenAPIContext;
|
||||
|
||||
/**
|
||||
* Extension interface which must be implemented by an OpenAPI extension
|
||||
*/
|
||||
interface Extension {
|
||||
|
||||
/**
|
||||
* Global context lazy initialization
|
||||
*
|
||||
* @param globalContext Global context
|
||||
*/
|
||||
void setGlobalContext(OpenAPIContext globalContext);
|
||||
|
||||
}
|
||||
@@ -1,41 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package io.github.swagger2markup.extension;
|
||||
|
||||
import io.github.swagger2markup.OpenSchema2MarkupConfig;
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter;
|
||||
import io.github.swagger2markup.Labels;
|
||||
import io.swagger.v3.oas.models.OpenAPI;
|
||||
import io.vavr.Function2;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
public abstract class MarkupComponent<D, T, R> implements Function2<D, T, R> {
|
||||
|
||||
protected Logger logger = LoggerFactory.getLogger(getClass());
|
||||
protected OpenAPI2MarkupConverter.Context<OpenAPI> context;
|
||||
protected Labels labels;
|
||||
protected OpenSchema2MarkupConfig config;
|
||||
protected OpenAPI2MarkupExtensionRegistry extensionRegistry;
|
||||
|
||||
public MarkupComponent(OpenAPI2MarkupConverter.OpenAPIContext context) {
|
||||
this.context = context;
|
||||
this.config = context.getConfig();
|
||||
this.extensionRegistry = context.getExtensionRegistry();
|
||||
this.labels = context.getLabels();
|
||||
}
|
||||
}
|
||||
@@ -1,58 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.extension;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* Extension points registry interface.
|
||||
*/
|
||||
public interface OpenAPI2MarkupExtensionRegistry extends Schema2MarkupExtensionRegistry {
|
||||
/**
|
||||
* OpenAPIModelExtension extension point can be used to preprocess the Swagger model.
|
||||
*
|
||||
* @return registered extensions extending OpenAPIModelExtension extension point
|
||||
*/
|
||||
List<OpenAPIModelExtension> getSwaggerModelExtensions();
|
||||
|
||||
/**
|
||||
* OverviewDocumentExtension extension point can be used to extend the overview document content.
|
||||
*
|
||||
* @return registered extensions extending OverviewDocumentExtension extension point
|
||||
*/
|
||||
List<OverviewDocumentExtension> getOverviewDocumentExtensions();
|
||||
|
||||
/**
|
||||
* DefinitionsDocumentExtension extension point can be used to extend the definitions document content.
|
||||
*
|
||||
* @return registered extensions extending DefinitionsDocumentExtension extension point
|
||||
*/
|
||||
List<DefinitionsDocumentExtension> getDefinitionsDocumentExtensions();
|
||||
|
||||
/**
|
||||
* SecurityContentExtension extension point can be used to extend the security document content.
|
||||
*
|
||||
* @return registered extensions extending SecurityContentExtension extension point
|
||||
*/
|
||||
List<SecurityDocumentExtension> getSecurityDocumentExtensions();
|
||||
|
||||
/**
|
||||
* PathsDocumentExtension extension point can be used to extend the paths document content.
|
||||
*
|
||||
* @return registered extensions extending PathsDocumentExtension extension point
|
||||
*/
|
||||
List<PathsDocumentExtension> getPathsDocumentExtensions();
|
||||
}
|
||||
@@ -1,28 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package io.github.swagger2markup.extension;
|
||||
|
||||
import io.swagger.v3.oas.models.OpenAPI;
|
||||
|
||||
/**
|
||||
* OpenAPIModelExtension extension point can be used to preprocess the Swagger model.
|
||||
*/
|
||||
public abstract class OpenAPIModelExtension extends AbstractExtension {
|
||||
|
||||
public abstract void apply(OpenAPI openAPI);
|
||||
|
||||
}
|
||||
@@ -1,52 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package io.github.swagger2markup.extension;
|
||||
|
||||
import org.asciidoctor.ast.Document;
|
||||
|
||||
/**
|
||||
* OverviewDocumentExtension extension point can be used to extend the overview document content.
|
||||
*/
|
||||
public abstract class OverviewDocumentExtension extends AbstractExtension {
|
||||
|
||||
public abstract void apply(Context context);
|
||||
|
||||
public enum Position {
|
||||
DOCUMENT_BEFORE,
|
||||
DOCUMENT_AFTER,
|
||||
DOCUMENT_BEGIN,
|
||||
DOCUMENT_END
|
||||
}
|
||||
|
||||
public static class Context extends ContentContext {
|
||||
private Position position;
|
||||
|
||||
/**
|
||||
* @param position the current position
|
||||
* @param document document object
|
||||
*/
|
||||
public Context(Position position, Document document) {
|
||||
super(document);
|
||||
this.position = position;
|
||||
}
|
||||
|
||||
public Position getPosition() {
|
||||
return position;
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,101 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package io.github.swagger2markup.extension;
|
||||
|
||||
import io.github.swagger2markup.model.PathOperation;
|
||||
import org.apache.commons.lang3.Validate;
|
||||
import org.asciidoctor.ast.Document;
|
||||
|
||||
import java.util.Optional;
|
||||
|
||||
/**
|
||||
* PathsDocumentExtension extension point can be used to extend the paths document content.
|
||||
*/
|
||||
public abstract class PathsDocumentExtension extends AbstractExtension {
|
||||
|
||||
public abstract void apply(Context context);
|
||||
|
||||
public enum Position {
|
||||
DOCUMENT_BEFORE,
|
||||
DOCUMENT_BEGIN,
|
||||
DOCUMENT_END,
|
||||
DOCUMENT_AFTER,
|
||||
OPERATION_BEFORE,
|
||||
OPERATION_BEGIN,
|
||||
OPERATION_END,
|
||||
OPERATION_AFTER,
|
||||
OPERATION_DESCRIPTION_BEFORE,
|
||||
OPERATION_DESCRIPTION_BEGIN,
|
||||
OPERATION_DESCRIPTION_END,
|
||||
OPERATION_DESCRIPTION_AFTER,
|
||||
OPERATION_PARAMETERS_BEFORE,
|
||||
OPERATION_PARAMETERS_BEGIN,
|
||||
OPERATION_PARAMETERS_END,
|
||||
OPERATION_PARAMETERS_AFTER,
|
||||
OPERATION_RESPONSES_BEFORE,
|
||||
OPERATION_RESPONSES_BEGIN,
|
||||
OPERATION_RESPONSES_END,
|
||||
OPERATION_RESPONSES_AFTER,
|
||||
OPERATION_SECURITY_BEFORE,
|
||||
OPERATION_SECURITY_BEGIN,
|
||||
OPERATION_SECURITY_END,
|
||||
OPERATION_SECURITY_AFTER
|
||||
}
|
||||
|
||||
public static class Context extends ContentContext {
|
||||
private Position position;
|
||||
/**
|
||||
* null if position == DOCUMENT_*
|
||||
*/
|
||||
private PathOperation operation;
|
||||
|
||||
/**
|
||||
* Context for positions DOCUMENT_*
|
||||
*
|
||||
* @param position the current position
|
||||
* @param document document object
|
||||
*/
|
||||
public Context(Position position, Document document) {
|
||||
super(document);
|
||||
Validate.inclusiveBetween(Position.DOCUMENT_BEFORE, Position.DOCUMENT_AFTER, position);
|
||||
this.position = position;
|
||||
}
|
||||
|
||||
/**
|
||||
* Context for all other positions
|
||||
*
|
||||
* @param position the current position
|
||||
* @param document document object
|
||||
* @param operation the current path operation
|
||||
*/
|
||||
public Context(Position position, Document document, PathOperation operation) {
|
||||
super(document);
|
||||
Validate.inclusiveBetween(Position.OPERATION_BEFORE, Position.OPERATION_SECURITY_AFTER, position);
|
||||
Validate.notNull(operation);
|
||||
this.position = position;
|
||||
this.operation = operation;
|
||||
}
|
||||
|
||||
public Position getPosition() {
|
||||
return position;
|
||||
}
|
||||
|
||||
public Optional<PathOperation> getOperation() {
|
||||
return Optional.ofNullable(operation);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,94 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package io.github.swagger2markup.extension;
|
||||
|
||||
import io.swagger.models.auth.SecuritySchemeDefinition;
|
||||
import org.apache.commons.lang3.Validate;
|
||||
import org.asciidoctor.ast.Document;
|
||||
|
||||
import java.util.Optional;
|
||||
|
||||
/**
|
||||
* SecurityContentExtension extension point can be used to extend the security document content.
|
||||
*/
|
||||
public abstract class SecurityDocumentExtension extends AbstractExtension {
|
||||
|
||||
|
||||
public abstract void apply(Context context);
|
||||
|
||||
public enum Position {
|
||||
DOCUMENT_BEFORE,
|
||||
DOCUMENT_BEGIN,
|
||||
DOCUMENT_END,
|
||||
DOCUMENT_AFTER,
|
||||
SECURITY_SCHEME_BEFORE,
|
||||
SECURITY_SCHEME_BEGIN,
|
||||
SECURITY_SCHEME_END,
|
||||
SECURITY_SCHEME_AFTER
|
||||
}
|
||||
|
||||
public static class Context extends ContentContext {
|
||||
private Position position;
|
||||
/**
|
||||
* null if position == DOCUMENT_*
|
||||
*/
|
||||
private String securitySchemeName;
|
||||
/**
|
||||
* null if position == DOCUMENT_*
|
||||
*/
|
||||
private SecuritySchemeDefinition securityScheme;
|
||||
|
||||
/**
|
||||
* @param position the current position
|
||||
* @param document the MarkupDocBuilder
|
||||
*/
|
||||
public Context(Position position, Document document) {
|
||||
super(document);
|
||||
Validate.inclusiveBetween(Position.DOCUMENT_BEFORE, Position.DOCUMENT_AFTER, position);
|
||||
this.position = position;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param position the current position
|
||||
* @param document the MarkupDocBuilder
|
||||
* @param securitySchemeName the name of the current securityScheme
|
||||
* @param securityScheme the current security scheme securityScheme
|
||||
*/
|
||||
public Context(Position position, Document document, String securitySchemeName, SecuritySchemeDefinition securityScheme) {
|
||||
super(document);
|
||||
Validate.inclusiveBetween(Position.SECURITY_SCHEME_BEFORE, Position.SECURITY_SCHEME_AFTER, position);
|
||||
Validate.notNull(securitySchemeName);
|
||||
Validate.notNull(securityScheme);
|
||||
this.position = position;
|
||||
this.securitySchemeName = securitySchemeName;
|
||||
this.securityScheme = securityScheme;
|
||||
}
|
||||
|
||||
public Position getPosition() {
|
||||
return position;
|
||||
}
|
||||
|
||||
public Optional<String> getSecuritySchemeName() {
|
||||
return Optional.ofNullable(securitySchemeName);
|
||||
}
|
||||
|
||||
public Optional<SecuritySchemeDefinition> getSecurityScheme() {
|
||||
return Optional.ofNullable(securityScheme);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,127 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package io.github.swagger2markup.extension.builder;
|
||||
|
||||
import io.github.swagger2markup.extension.*;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import static java.util.ServiceLoader.load;
|
||||
import static org.apache.commons.collections4.IteratorUtils.toList;
|
||||
|
||||
public class OpenAPI2MarkupExtensionRegistryBuilder {
|
||||
|
||||
private final Context context;
|
||||
|
||||
public OpenAPI2MarkupExtensionRegistryBuilder() {
|
||||
List<OpenAPIModelExtension> openAPIModelExtensions = toList(load(OpenAPIModelExtension.class).iterator());
|
||||
List<OverviewDocumentExtension> overviewDocumentExtensions = toList(load(OverviewDocumentExtension.class).iterator());
|
||||
List<DefinitionsDocumentExtension> definitionsDocumentExtensions = toList(load(DefinitionsDocumentExtension.class).iterator());
|
||||
List<PathsDocumentExtension> pathsDocumentExtensions = toList(load(PathsDocumentExtension.class).iterator());
|
||||
List<SecurityDocumentExtension> securityDocumentExtensions = toList(load(SecurityDocumentExtension.class).iterator());
|
||||
context = new Context(
|
||||
openAPIModelExtensions,
|
||||
overviewDocumentExtensions,
|
||||
definitionsDocumentExtensions,
|
||||
pathsDocumentExtensions,
|
||||
securityDocumentExtensions);
|
||||
}
|
||||
|
||||
public OpenAPI2MarkupExtensionRegistry build() {
|
||||
return new DefaultOpenAPI2MarkupExtensionRegistry(context);
|
||||
}
|
||||
|
||||
public OpenAPI2MarkupExtensionRegistryBuilder withSwaggerModelExtension(OpenAPIModelExtension extension) {
|
||||
context.openAPIModelExtensions.add(extension);
|
||||
return this;
|
||||
}
|
||||
|
||||
public OpenAPI2MarkupExtensionRegistryBuilder withOverviewDocumentExtension(OverviewDocumentExtension extension) {
|
||||
context.overviewDocumentExtensions.add(extension);
|
||||
return this;
|
||||
}
|
||||
|
||||
public OpenAPI2MarkupExtensionRegistryBuilder withDefinitionsDocumentExtension(DefinitionsDocumentExtension extension) {
|
||||
context.definitionsDocumentExtensions.add(extension);
|
||||
return this;
|
||||
}
|
||||
|
||||
public OpenAPI2MarkupExtensionRegistryBuilder withPathsDocumentExtension(PathsDocumentExtension extension) {
|
||||
context.pathsDocumentExtensions.add(extension);
|
||||
return this;
|
||||
}
|
||||
|
||||
public OpenAPI2MarkupExtensionRegistryBuilder withSecurityDocumentExtension(SecurityDocumentExtension extension) {
|
||||
context.securityDocumentExtensions.add(extension);
|
||||
return this;
|
||||
}
|
||||
|
||||
static class DefaultOpenAPI2MarkupExtensionRegistry implements OpenAPI2MarkupExtensionRegistry {
|
||||
|
||||
private Context context;
|
||||
|
||||
DefaultOpenAPI2MarkupExtensionRegistry(Context context) {
|
||||
this.context = context;
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<OpenAPIModelExtension> getSwaggerModelExtensions() {
|
||||
return context.openAPIModelExtensions;
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<OverviewDocumentExtension> getOverviewDocumentExtensions() {
|
||||
return context.overviewDocumentExtensions;
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<DefinitionsDocumentExtension> getDefinitionsDocumentExtensions() {
|
||||
return context.definitionsDocumentExtensions;
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<SecurityDocumentExtension> getSecurityDocumentExtensions() {
|
||||
return context.securityDocumentExtensions;
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<PathsDocumentExtension> getPathsDocumentExtensions() {
|
||||
return context.pathsDocumentExtensions;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
private static class Context {
|
||||
final List<OpenAPIModelExtension> openAPIModelExtensions;
|
||||
final List<OverviewDocumentExtension> overviewDocumentExtensions;
|
||||
final List<DefinitionsDocumentExtension> definitionsDocumentExtensions;
|
||||
final List<PathsDocumentExtension> pathsDocumentExtensions;
|
||||
final List<SecurityDocumentExtension> securityDocumentExtensions;
|
||||
|
||||
Context(List<OpenAPIModelExtension> openAPIModelExtensions,
|
||||
List<OverviewDocumentExtension> overviewDocumentExtensions,
|
||||
List<DefinitionsDocumentExtension> definitionsDocumentExtensions,
|
||||
List<PathsDocumentExtension> pathsDocumentExtensions,
|
||||
List<SecurityDocumentExtension> securityDocumentExtensions) {
|
||||
this.openAPIModelExtensions = openAPIModelExtensions;
|
||||
this.overviewDocumentExtensions = overviewDocumentExtensions;
|
||||
this.definitionsDocumentExtensions = definitionsDocumentExtensions;
|
||||
this.pathsDocumentExtensions = pathsDocumentExtensions;
|
||||
this.securityDocumentExtensions = securityDocumentExtensions;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,101 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.internal.component;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter;
|
||||
import io.github.swagger2markup.adoc.ast.impl.DescriptionListEntryImpl;
|
||||
import io.github.swagger2markup.adoc.ast.impl.DescriptionListImpl;
|
||||
import io.github.swagger2markup.adoc.ast.impl.ListItemImpl;
|
||||
import io.github.swagger2markup.adoc.ast.impl.ParagraphBlockImpl;
|
||||
import io.github.swagger2markup.extension.MarkupComponent;
|
||||
import io.swagger.v3.oas.models.media.Encoding;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.asciidoctor.ast.StructuralNode;
|
||||
|
||||
import java.util.Collections;
|
||||
import java.util.Map;
|
||||
|
||||
import static io.github.swagger2markup.adoc.converter.internal.Delimiters.LINE_SEPARATOR;
|
||||
import static io.github.swagger2markup.config.OpenAPILabels.LABEL_EXAMPLES;
|
||||
import static io.github.swagger2markup.internal.helper.OpenApiHelpers.italicUnconstrained;
|
||||
|
||||
public class EncodingComponent extends MarkupComponent<StructuralNode, EncodingComponent.Parameters, StructuralNode> {
|
||||
|
||||
private final HeadersComponent headersComponent;
|
||||
|
||||
public EncodingComponent(OpenAPI2MarkupConverter.OpenAPIContext context) {
|
||||
super(context);
|
||||
this.headersComponent = new HeadersComponent(context);
|
||||
}
|
||||
|
||||
public static EncodingComponent.Parameters parameters(Map<String, Encoding> encodings) {
|
||||
return new EncodingComponent.Parameters(encodings);
|
||||
}
|
||||
|
||||
public StructuralNode apply(StructuralNode node, Map<String, Encoding> encodings) {
|
||||
return apply(node, parameters(encodings));
|
||||
}
|
||||
|
||||
@Override
|
||||
public StructuralNode apply(StructuralNode node, EncodingComponent.Parameters parameters) {
|
||||
Map<String, Encoding> encodings = parameters.encodings;
|
||||
if (encodings == null || encodings.isEmpty()) return node;
|
||||
|
||||
DescriptionListImpl encodingList = new DescriptionListImpl(node);
|
||||
encodingList.setTitle(labels.getLabel(LABEL_EXAMPLES));
|
||||
|
||||
encodings.forEach((name, encoding) -> {
|
||||
DescriptionListEntryImpl encodingEntry = new DescriptionListEntryImpl(encodingList, Collections.singletonList(new ListItemImpl(encodingList, name)));
|
||||
ListItemImpl tagDesc = new ListItemImpl(encodingEntry, "");
|
||||
ParagraphBlockImpl encodingBlock = new ParagraphBlockImpl(tagDesc);
|
||||
|
||||
StringBuilder sb = new StringBuilder();
|
||||
String contentType = encoding.getContentType();
|
||||
if(StringUtils.isNotBlank(contentType)){
|
||||
sb.append("Content-Type:").append(contentType).append(LINE_SEPARATOR);
|
||||
}
|
||||
if(encoding.getAllowReserved()){
|
||||
sb.append(italicUnconstrained("Allow Reserved").toLowerCase()).append(LINE_SEPARATOR);
|
||||
}
|
||||
if(encoding.getExplode()){
|
||||
sb.append(italicUnconstrained("Explode").toLowerCase()).append(LINE_SEPARATOR);
|
||||
}
|
||||
Encoding.StyleEnum style = encoding.getStyle();
|
||||
if(style != null){
|
||||
sb.append("style").append(style).append(LINE_SEPARATOR);
|
||||
}
|
||||
encodingBlock.setSource(sb.toString());
|
||||
tagDesc.append(encodingBlock);
|
||||
headersComponent.apply(tagDesc, encoding.getHeaders());
|
||||
|
||||
encodingEntry.setDescription(tagDesc);
|
||||
|
||||
encodingList.addEntry(encodingEntry);
|
||||
});
|
||||
node.append(encodingList);
|
||||
|
||||
return node;
|
||||
}
|
||||
|
||||
public static class Parameters {
|
||||
|
||||
private final Map<String, Encoding> encodings;
|
||||
|
||||
public Parameters(Map<String, Encoding> encodings) {
|
||||
this.encodings = encodings;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,108 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.internal.component;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter;
|
||||
import io.github.swagger2markup.adoc.ast.impl.DescriptionListEntryImpl;
|
||||
import io.github.swagger2markup.adoc.ast.impl.DescriptionListImpl;
|
||||
import io.github.swagger2markup.adoc.ast.impl.ListItemImpl;
|
||||
import io.github.swagger2markup.adoc.ast.impl.ParagraphBlockImpl;
|
||||
import io.github.swagger2markup.extension.MarkupComponent;
|
||||
import io.swagger.v3.oas.models.examples.Example;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.asciidoctor.ast.StructuralNode;
|
||||
|
||||
import java.util.Collections;
|
||||
import java.util.Map;
|
||||
|
||||
import static io.github.swagger2markup.adoc.converter.internal.Delimiters.LINE_SEPARATOR;
|
||||
import static io.github.swagger2markup.config.OpenAPILabels.LABEL_EXAMPLES;
|
||||
import static io.github.swagger2markup.config.OpenAPILabels.LABEL_EXTERNAL_VALUE;
|
||||
import static io.github.swagger2markup.internal.helper.OpenApiHelpers.appendDescription;
|
||||
|
||||
public class ExamplesComponent extends MarkupComponent<StructuralNode, ExamplesComponent.Parameters, StructuralNode> {
|
||||
|
||||
private final MediaTypeExampleComponent mediaTypeExampleComponent;
|
||||
|
||||
public ExamplesComponent(OpenAPI2MarkupConverter.OpenAPIContext context) {
|
||||
super(context);
|
||||
this.mediaTypeExampleComponent = new MediaTypeExampleComponent(context);
|
||||
}
|
||||
|
||||
public static ExamplesComponent.Parameters parameters(Map<String, Example> examples) {
|
||||
return new ExamplesComponent.Parameters(examples);
|
||||
}
|
||||
|
||||
public StructuralNode apply(StructuralNode node, Map<String, Example> examples) {
|
||||
return apply(node, parameters(examples));
|
||||
}
|
||||
|
||||
@Override
|
||||
public StructuralNode apply(StructuralNode node, ExamplesComponent.Parameters parameters) {
|
||||
Map<String, Example> examples = parameters.examples;
|
||||
if (examples == null || examples.isEmpty()) return node;
|
||||
|
||||
DescriptionListImpl examplesList = new DescriptionListImpl(node);
|
||||
examplesList.setTitle(labels.getLabel(LABEL_EXAMPLES));
|
||||
|
||||
examples.forEach((name, example) -> {
|
||||
DescriptionListEntryImpl exampleEntry = new DescriptionListEntryImpl(examplesList, Collections.singletonList(new ListItemImpl(examplesList, name)));
|
||||
ListItemImpl tagDesc = new ListItemImpl(exampleEntry, "");
|
||||
|
||||
ParagraphBlockImpl exampleBlock = new ParagraphBlockImpl(tagDesc);
|
||||
|
||||
appendDescription(exampleBlock, example.getSummary());
|
||||
appendDescription(exampleBlock, example.getDescription());
|
||||
mediaTypeExampleComponent.apply(tagDesc, example.getValue());
|
||||
|
||||
ParagraphBlockImpl paragraphBlock = new ParagraphBlockImpl(tagDesc);
|
||||
String source = "";
|
||||
generateRefLink(source, example.getExternalValue(), labels.getLabel(LABEL_EXTERNAL_VALUE));
|
||||
generateRefLink(source, example.get$ref(), "");
|
||||
if(StringUtils.isNotBlank(source)){
|
||||
paragraphBlock.setSource(source);
|
||||
tagDesc.append(paragraphBlock);
|
||||
}
|
||||
|
||||
exampleEntry.setDescription(tagDesc);
|
||||
|
||||
examplesList.addEntry(exampleEntry);
|
||||
});
|
||||
node.append(examplesList);
|
||||
|
||||
return node;
|
||||
}
|
||||
|
||||
private String generateRefLink(String source, String ref, String alt) {
|
||||
if (StringUtils.isNotBlank(ref)) {
|
||||
if (StringUtils.isBlank(alt)) {
|
||||
alt = ref.substring(ref.lastIndexOf('/') + 1);
|
||||
}
|
||||
String anchor = ref.replaceFirst("#", "").replaceAll("/", "_");
|
||||
source += "<<" + anchor + "," + alt + ">>" + LINE_SEPARATOR;
|
||||
}
|
||||
return source;
|
||||
}
|
||||
|
||||
public static class Parameters {
|
||||
|
||||
private final Map<String, Example> examples;
|
||||
|
||||
public Parameters(Map<String, Example> examples) {
|
||||
this.examples = examples;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,64 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.internal.component;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter;
|
||||
import io.github.swagger2markup.extension.MarkupComponent;
|
||||
import io.github.swagger2markup.adoc.ast.impl.ParagraphBlockImpl;
|
||||
import io.swagger.v3.oas.models.ExternalDocumentation;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.asciidoctor.ast.Block;
|
||||
import org.asciidoctor.ast.StructuralNode;
|
||||
|
||||
|
||||
public class ExternalDocumentationComponent extends MarkupComponent<StructuralNode, ExternalDocumentationComponent.Parameters, StructuralNode> {
|
||||
|
||||
public ExternalDocumentationComponent(OpenAPI2MarkupConverter.OpenAPIContext context) {
|
||||
super(context);
|
||||
}
|
||||
|
||||
public static Parameters parameters(ExternalDocumentation externalDocs) {
|
||||
return new Parameters(externalDocs);
|
||||
}
|
||||
|
||||
public StructuralNode apply(StructuralNode node, ExternalDocumentation externalDocs) {
|
||||
return apply(node, parameters(externalDocs));
|
||||
}
|
||||
|
||||
@Override
|
||||
public StructuralNode apply(StructuralNode node, Parameters params) {
|
||||
ExternalDocumentation externalDocs = params.externalDocs;
|
||||
if (externalDocs == null) return node;
|
||||
|
||||
String url = externalDocs.getUrl();
|
||||
if (StringUtils.isNotBlank(url)) {
|
||||
Block paragraph = new ParagraphBlockImpl(node);
|
||||
String desc = externalDocs.getDescription();
|
||||
paragraph.setSource(url + (StringUtils.isNotBlank(desc) ? "[" + desc + "]" : ""));
|
||||
node.append(paragraph);
|
||||
}
|
||||
|
||||
return node;
|
||||
}
|
||||
|
||||
public static class Parameters {
|
||||
private final ExternalDocumentation externalDocs;
|
||||
|
||||
public Parameters(ExternalDocumentation externalDocs) {
|
||||
this.externalDocs = externalDocs;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,79 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.internal.component;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter;
|
||||
import io.github.swagger2markup.adoc.ast.impl.TableImpl;
|
||||
import io.github.swagger2markup.extension.MarkupComponent;
|
||||
import io.swagger.v3.oas.models.headers.Header;
|
||||
import org.asciidoctor.ast.StructuralNode;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import java.util.Optional;
|
||||
|
||||
import static io.github.swagger2markup.config.OpenAPILabels.*;
|
||||
import static io.github.swagger2markup.internal.helper.OpenApiHelpers.generateInnerDoc;
|
||||
import static io.github.swagger2markup.internal.helper.OpenApiHelpers.getSchemaTypeAsString;
|
||||
|
||||
public class HeadersComponent extends MarkupComponent<StructuralNode, HeadersComponent.Parameters, StructuralNode> {
|
||||
|
||||
private final SchemaComponent schemaComponent;
|
||||
|
||||
public HeadersComponent(OpenAPI2MarkupConverter.OpenAPIContext context) {
|
||||
super(context);
|
||||
this.schemaComponent = new SchemaComponent(context);
|
||||
}
|
||||
|
||||
public static HeadersComponent.Parameters parameters(Map<String, Header> headers) {
|
||||
return new HeadersComponent.Parameters(headers);
|
||||
}
|
||||
|
||||
public StructuralNode apply(StructuralNode node, Map<String, Header> headers) {
|
||||
return apply(node, parameters(headers));
|
||||
}
|
||||
|
||||
@Override
|
||||
public StructuralNode apply(StructuralNode node, HeadersComponent.Parameters parameters) {
|
||||
Map<String, Header> headers = parameters.headers;
|
||||
if (null == headers || headers.isEmpty()) return node;
|
||||
|
||||
TableImpl responseHeadersTable = new TableImpl(node, new HashMap<>(), new ArrayList<>());
|
||||
responseHeadersTable.setOption("header");
|
||||
responseHeadersTable.setAttribute("caption", "", true);
|
||||
responseHeadersTable.setAttribute("cols", ".^2a,.^14a,.^4a", true);
|
||||
responseHeadersTable.setTitle(labels.getLabel(TABLE_TITLE_HEADERS));
|
||||
responseHeadersTable.setHeaderRow(labels.getLabel(TABLE_HEADER_NAME), labels.getLabel(TABLE_HEADER_DESCRIPTION), labels.getLabel(TABLE_HEADER_SCHEMA));
|
||||
headers.forEach((name, header) ->
|
||||
responseHeadersTable.addRow(
|
||||
generateInnerDoc(responseHeadersTable, name),
|
||||
generateInnerDoc(responseHeadersTable, Optional.ofNullable(header.getDescription()).orElse("")),
|
||||
generateInnerDoc(responseHeadersTable, getSchemaTypeAsString(header.getSchema()))
|
||||
));
|
||||
node.append(responseHeadersTable);
|
||||
return node;
|
||||
}
|
||||
|
||||
public static class Parameters {
|
||||
|
||||
private final Map<String, Header> headers;
|
||||
|
||||
public Parameters(Map<String, Header> headers) {
|
||||
this.headers = headers;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,82 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.internal.component;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter;
|
||||
import io.github.swagger2markup.adoc.ast.impl.DocumentImpl;
|
||||
import io.github.swagger2markup.adoc.ast.impl.ParagraphBlockImpl;
|
||||
import io.github.swagger2markup.extension.MarkupComponent;
|
||||
import io.swagger.v3.oas.models.links.Link;
|
||||
import org.asciidoctor.ast.Document;
|
||||
import org.asciidoctor.ast.StructuralNode;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
import static io.github.swagger2markup.adoc.converter.internal.Delimiters.LINE_SEPARATOR;
|
||||
import static io.github.swagger2markup.config.OpenAPILabels.*;
|
||||
import static io.github.swagger2markup.internal.helper.OpenApiHelpers.italicUnconstrained;
|
||||
|
||||
public class LinkComponent extends MarkupComponent<StructuralNode, LinkComponent.Parameters, StructuralNode> {
|
||||
|
||||
public LinkComponent(OpenAPI2MarkupConverter.OpenAPIContext context) {
|
||||
super(context);
|
||||
}
|
||||
|
||||
public static LinkComponent.Parameters parameters(Map<String, Link> links) {
|
||||
return new LinkComponent.Parameters(links);
|
||||
}
|
||||
|
||||
public Document apply(StructuralNode parent, Map<String, Link> links) {
|
||||
return apply(parent, parameters(links));
|
||||
}
|
||||
|
||||
@Override
|
||||
public Document apply(StructuralNode parent, LinkComponent.Parameters parameters) {
|
||||
DocumentImpl linksDocument = new DocumentImpl(parent);
|
||||
ParagraphBlockImpl linkParagraph = new ParagraphBlockImpl(linksDocument);
|
||||
|
||||
Map<String, Link> links = parameters.links;
|
||||
if (null == links || links.isEmpty()) {
|
||||
linkParagraph.setSource(labels.getLabel(LABEL_NO_LINKS));
|
||||
} else {
|
||||
StringBuilder sb = new StringBuilder();
|
||||
links.forEach((name, link) -> {
|
||||
sb.append(name).append(" +").append(LINE_SEPARATOR);
|
||||
sb.append(italicUnconstrained(labels.getLabel(LABEL_OPERATION))).append(' ')
|
||||
.append(italicUnconstrained(link.getOperationId())).append(" +").append(LINE_SEPARATOR);
|
||||
Map<String, String> linkParameters = link.getParameters();
|
||||
if (null != linkParameters && !linkParameters.isEmpty()) {
|
||||
sb.append(italicUnconstrained(labels.getLabel(LABEL_PARAMETERS))).append(" {").append(" +").append(LINE_SEPARATOR);
|
||||
linkParameters.forEach((param, value) ->
|
||||
sb.append('"').append(param).append("\": \"").append(value).append('"').append(" +").append(LINE_SEPARATOR)
|
||||
);
|
||||
sb.append('}').append(" +").append(LINE_SEPARATOR);
|
||||
}
|
||||
});
|
||||
linkParagraph.setSource(sb.toString());
|
||||
}
|
||||
linksDocument.append(linkParagraph);
|
||||
return linksDocument;
|
||||
}
|
||||
|
||||
public static class Parameters {
|
||||
private final Map<String, Link> links;
|
||||
|
||||
public Parameters(Map<String, Link> links) {
|
||||
this.links = links;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,87 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.internal.component;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter;
|
||||
import io.github.swagger2markup.adoc.ast.impl.DescriptionListEntryImpl;
|
||||
import io.github.swagger2markup.adoc.ast.impl.DescriptionListImpl;
|
||||
import io.github.swagger2markup.adoc.ast.impl.ListItemImpl;
|
||||
import io.github.swagger2markup.extension.MarkupComponent;
|
||||
import io.swagger.v3.oas.models.media.Content;
|
||||
import org.asciidoctor.ast.Document;
|
||||
import org.asciidoctor.ast.StructuralNode;
|
||||
|
||||
import java.util.Collections;
|
||||
|
||||
import static io.github.swagger2markup.config.OpenAPILabels.LABEL_CONTENT;
|
||||
|
||||
public class MediaContentComponent extends MarkupComponent<StructuralNode, MediaContentComponent.Parameters, StructuralNode> {
|
||||
|
||||
private final MediaTypeExampleComponent mediaTypeExampleComponent;
|
||||
private final ExamplesComponent examplesComponent;
|
||||
private final SchemaComponent schemaComponent;
|
||||
private final EncodingComponent encodingComponent;
|
||||
|
||||
public MediaContentComponent(OpenAPI2MarkupConverter.OpenAPIContext context) {
|
||||
super(context);
|
||||
this.mediaTypeExampleComponent = new MediaTypeExampleComponent(context);
|
||||
this.examplesComponent = new ExamplesComponent(context);
|
||||
this.schemaComponent = new SchemaComponent(context);
|
||||
this.encodingComponent = new EncodingComponent(context);
|
||||
}
|
||||
|
||||
public static MediaContentComponent.Parameters parameters(Content content) {
|
||||
return new MediaContentComponent.Parameters(content);
|
||||
}
|
||||
|
||||
public StructuralNode apply(StructuralNode node, Content content) {
|
||||
return apply(node, parameters(content));
|
||||
}
|
||||
|
||||
@Override
|
||||
public StructuralNode apply(StructuralNode node, MediaContentComponent.Parameters parameters) {
|
||||
Content content = parameters.content;
|
||||
if (content == null || content.isEmpty()) return node;
|
||||
|
||||
DescriptionListImpl mediaContentList = new DescriptionListImpl(node);
|
||||
mediaContentList.setTitle(labels.getLabel(LABEL_CONTENT));
|
||||
|
||||
content.forEach((type, mediaType) -> {
|
||||
DescriptionListEntryImpl tagEntry = new DescriptionListEntryImpl(mediaContentList, Collections.singletonList(new ListItemImpl(mediaContentList, type)));
|
||||
ListItemImpl tagDesc = new ListItemImpl(tagEntry, "");
|
||||
|
||||
Document tagDescDocument = schemaComponent.apply(mediaContentList, mediaType.getSchema());
|
||||
mediaTypeExampleComponent.apply(tagDescDocument, mediaType.getExample());
|
||||
examplesComponent.apply(tagDescDocument, mediaType.getExamples());
|
||||
encodingComponent.apply(tagDescDocument, mediaType.getEncoding());
|
||||
tagDesc.append(tagDescDocument);
|
||||
|
||||
tagEntry.setDescription(tagDesc);
|
||||
mediaContentList.addEntry(tagEntry);
|
||||
});
|
||||
node.append(mediaContentList);
|
||||
return node;
|
||||
}
|
||||
|
||||
public static class Parameters {
|
||||
|
||||
private final Content content;
|
||||
|
||||
public Parameters(Content content) {
|
||||
this.content = content;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,64 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.internal.component;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter;
|
||||
import io.github.swagger2markup.adoc.ast.impl.ParagraphBlockImpl;
|
||||
import io.github.swagger2markup.extension.MarkupComponent;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.asciidoctor.ast.StructuralNode;
|
||||
|
||||
import static io.github.swagger2markup.adoc.converter.internal.Delimiters.DELIMITER_BLOCK;
|
||||
import static io.github.swagger2markup.adoc.converter.internal.Delimiters.LINE_SEPARATOR;
|
||||
import static io.github.swagger2markup.config.OpenAPILabels.LABEL_EXAMPLE;
|
||||
|
||||
public class MediaTypeExampleComponent extends MarkupComponent<StructuralNode, MediaTypeExampleComponent.Parameters, StructuralNode> {
|
||||
|
||||
public MediaTypeExampleComponent(OpenAPI2MarkupConverter.OpenAPIContext context) {
|
||||
super(context);
|
||||
}
|
||||
|
||||
public static MediaTypeExampleComponent.Parameters parameters(Object example) {
|
||||
return new MediaTypeExampleComponent.Parameters(example);
|
||||
}
|
||||
|
||||
public StructuralNode apply(StructuralNode node, Object example) {
|
||||
return apply(node, parameters(example));
|
||||
}
|
||||
|
||||
@Override
|
||||
public StructuralNode apply(StructuralNode node, MediaTypeExampleComponent.Parameters parameters) {
|
||||
Object example = parameters.example;
|
||||
if (example == null || StringUtils.isBlank(example.toString())) return node;
|
||||
|
||||
ParagraphBlockImpl sourceBlock = new ParagraphBlockImpl(node);
|
||||
sourceBlock.setTitle(labels.getLabel(LABEL_EXAMPLE));
|
||||
sourceBlock.setAttribute("style", "source", true);
|
||||
sourceBlock.setSource(DELIMITER_BLOCK + LINE_SEPARATOR + example + LINE_SEPARATOR + DELIMITER_BLOCK);
|
||||
node.append(sourceBlock);
|
||||
|
||||
return node;
|
||||
}
|
||||
|
||||
public static class Parameters {
|
||||
|
||||
private final Object example;
|
||||
|
||||
public Parameters(Object example) {
|
||||
this.example = example;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,103 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.internal.component;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter;
|
||||
import io.github.swagger2markup.adoc.ast.impl.TableImpl;
|
||||
import io.github.swagger2markup.extension.MarkupComponent;
|
||||
import io.swagger.v3.oas.models.parameters.Parameter;
|
||||
import org.asciidoctor.ast.Document;
|
||||
import org.asciidoctor.ast.StructuralNode;
|
||||
import org.asciidoctor.ast.Table;
|
||||
|
||||
import java.util.*;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
import static io.github.swagger2markup.adoc.converter.internal.Delimiters.LINE_SEPARATOR;
|
||||
import static io.github.swagger2markup.config.OpenAPILabels.*;
|
||||
import static io.github.swagger2markup.internal.helper.OpenApiHelpers.*;
|
||||
|
||||
public class ParametersComponent extends MarkupComponent<StructuralNode, ParametersComponent.Parameters, StructuralNode> {
|
||||
|
||||
private final SchemaComponent schemaComponent;
|
||||
|
||||
public ParametersComponent(OpenAPI2MarkupConverter.OpenAPIContext context) {
|
||||
super(context);
|
||||
this.schemaComponent = new SchemaComponent(context);
|
||||
}
|
||||
|
||||
public static ParametersComponent.Parameters parameters(Map<String, Parameter> parameters) {
|
||||
return new ParametersComponent.Parameters(parameters);
|
||||
}
|
||||
|
||||
public static ParametersComponent.Parameters parameters(List<Parameter> parameters) {
|
||||
if(null == parameters) {
|
||||
return new ParametersComponent.Parameters(new HashMap<>());
|
||||
}
|
||||
return new ParametersComponent.Parameters(parameters.stream().collect(Collectors.toMap(Parameter::getName, parameter -> parameter)));
|
||||
}
|
||||
|
||||
public StructuralNode apply(StructuralNode parent, List<Parameter> params) {
|
||||
return apply(parent, parameters(params));
|
||||
}
|
||||
|
||||
public StructuralNode apply(StructuralNode parent, Map<String, Parameter> params) {
|
||||
return apply(parent, parameters(params));
|
||||
}
|
||||
|
||||
@Override
|
||||
public StructuralNode apply(StructuralNode parent, ParametersComponent.Parameters componentParameters) {
|
||||
Map<String, Parameter> parameters = componentParameters.parameters;
|
||||
if (null == parameters || parameters.isEmpty()) return parent;
|
||||
|
||||
TableImpl pathParametersTable = new TableImpl(parent, new HashMap<>(), new ArrayList<>());
|
||||
pathParametersTable.setOption("header");
|
||||
pathParametersTable.setAttribute("caption", "", true);
|
||||
pathParametersTable.setAttribute("cols", ".^2a,.^3a,.^10a,.^5a", true);
|
||||
pathParametersTable.setTitle(labels.getLabel(TABLE_TITLE_PARAMETERS));
|
||||
pathParametersTable.setHeaderRow(
|
||||
labels.getLabel(TABLE_HEADER_TYPE),
|
||||
labels.getLabel(TABLE_HEADER_NAME),
|
||||
labels.getLabel(TABLE_HEADER_DESCRIPTION),
|
||||
labels.getLabel(TABLE_HEADER_SCHEMA));
|
||||
|
||||
parameters.forEach((alt, parameter) ->
|
||||
pathParametersTable.addRow(
|
||||
generateInnerDoc(pathParametersTable, boldUnconstrained(parameter.getIn()), alt),
|
||||
getParameterNameDocument(pathParametersTable, parameter),
|
||||
generateInnerDoc(pathParametersTable, Optional.ofNullable(parameter.getDescription()).orElse("")),
|
||||
generateInnerDoc(pathParametersTable, getSchemaTypeAsString(parameter.getSchema()))
|
||||
));
|
||||
parent.append(pathParametersTable);
|
||||
|
||||
return parent;
|
||||
}
|
||||
|
||||
private Document getParameterNameDocument(Table table, Parameter parameter) {
|
||||
String documentContent = boldUnconstrained(parameter.getName()) + " +" + LINE_SEPARATOR + requiredIndicator(parameter.getRequired(),
|
||||
labels.getLabel(LABEL_REQUIRED), labels.getLabel(LABEL_OPTIONAL));
|
||||
return generateInnerDoc(table, documentContent);
|
||||
}
|
||||
|
||||
public static class Parameters {
|
||||
|
||||
private final Map<String, Parameter> parameters;
|
||||
|
||||
public Parameters(Map<String, Parameter> parameters) {
|
||||
this.parameters = parameters;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,89 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.internal.component;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter;
|
||||
import io.github.swagger2markup.adoc.ast.impl.TableImpl;
|
||||
import io.github.swagger2markup.extension.MarkupComponent;
|
||||
import io.swagger.v3.oas.models.media.Schema;
|
||||
import org.asciidoctor.ast.StructuralNode;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import static io.github.swagger2markup.adoc.converter.internal.Delimiters.LINE_SEPARATOR;
|
||||
import static io.github.swagger2markup.config.OpenAPILabels.*;
|
||||
import static io.github.swagger2markup.internal.helper.OpenApiHelpers.*;
|
||||
|
||||
public class PropertiesTableComponent extends MarkupComponent<StructuralNode, PropertiesTableComponent.Parameters, StructuralNode> {
|
||||
|
||||
private final SchemaComponent schemaComponent;
|
||||
|
||||
PropertiesTableComponent(OpenAPI2MarkupConverter.OpenAPIContext context) {
|
||||
super(context);
|
||||
this.schemaComponent = new SchemaComponent(context);
|
||||
}
|
||||
|
||||
public static Parameters parameters(@SuppressWarnings("rawtypes") Map<String, Schema> properties, List<String> schemaRequired) {
|
||||
return new Parameters(properties, schemaRequired);
|
||||
}
|
||||
|
||||
public StructuralNode apply(StructuralNode parent, @SuppressWarnings("rawtypes") Map<String, Schema> properties, List<String> schemaRequired) {
|
||||
return apply(parent, parameters(properties, schemaRequired));
|
||||
}
|
||||
|
||||
public StructuralNode apply(StructuralNode parent, Parameters params) {
|
||||
@SuppressWarnings("rawtypes") Map<String, Schema> properties = params.properties;
|
||||
List<String> schemaRequired = params.schemaRequired;
|
||||
|
||||
if (null == properties || properties.isEmpty()) return parent;
|
||||
|
||||
List<String> finalSchemaRequired = (null == schemaRequired) ? new ArrayList<>() : schemaRequired;
|
||||
|
||||
TableImpl propertiesTable = new TableImpl(parent, new HashMap<>(), new ArrayList<>());
|
||||
propertiesTable.setOption("header");
|
||||
propertiesTable.setAttribute("caption", "", true);
|
||||
propertiesTable.setAttribute("cols", ".^4a,.^16a,.^4a", true);
|
||||
propertiesTable.setTitle(labels.getLabel(TABLE_TITLE_PROPERTIES));
|
||||
propertiesTable.setHeaderRow(
|
||||
labels.getLabel(TABLE_HEADER_NAME),
|
||||
labels.getLabel(TABLE_HEADER_DESCRIPTION),
|
||||
labels.getLabel(TABLE_HEADER_SCHEMA));
|
||||
|
||||
properties.forEach((name, schema) -> propertiesTable.addRow(
|
||||
generateInnerDoc(propertiesTable, name + LINE_SEPARATOR + requiredIndicator(finalSchemaRequired.contains(name),
|
||||
labels.getLabel(LABEL_REQUIRED), labels.getLabel(LABEL_OPTIONAL))),
|
||||
schemaComponent.apply(propertiesTable, schema),
|
||||
generateInnerDoc(propertiesTable, getSchemaTypeAsString(schema))
|
||||
));
|
||||
parent.append(propertiesTable);
|
||||
return parent;
|
||||
}
|
||||
|
||||
@SuppressWarnings("rawtypes")
|
||||
public static class Parameters {
|
||||
private final Map<String, Schema> properties;
|
||||
private final List<String> schemaRequired;
|
||||
|
||||
public Parameters(Map<String, Schema> properties, List<String> schemaRequired) {
|
||||
|
||||
this.properties = properties;
|
||||
this.schemaRequired = schemaRequired;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,96 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.internal.component;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter;
|
||||
import io.github.swagger2markup.adoc.ast.impl.TableImpl;
|
||||
import io.github.swagger2markup.extension.MarkupComponent;
|
||||
import io.swagger.v3.oas.models.responses.ApiResponse;
|
||||
import org.asciidoctor.ast.Document;
|
||||
import org.asciidoctor.ast.StructuralNode;
|
||||
import org.asciidoctor.ast.Table;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import java.util.Optional;
|
||||
|
||||
import static io.github.swagger2markup.config.OpenAPILabels.*;
|
||||
import static io.github.swagger2markup.internal.helper.OpenApiHelpers.generateInnerDoc;
|
||||
|
||||
public class ResponseComponent extends MarkupComponent<StructuralNode, ResponseComponent.Parameters, StructuralNode> {
|
||||
|
||||
private final HeadersComponent headersComponent;
|
||||
private final LinkComponent linkComponent;
|
||||
private final MediaContentComponent mediaContentComponent;
|
||||
|
||||
public ResponseComponent(OpenAPI2MarkupConverter.OpenAPIContext context) {
|
||||
super(context);
|
||||
this.headersComponent = new HeadersComponent(context);
|
||||
this.linkComponent = new LinkComponent(context);
|
||||
this.mediaContentComponent = new MediaContentComponent(context);
|
||||
}
|
||||
|
||||
public static Parameters parameters(Map<String, ApiResponse> apiResponses) {
|
||||
return new Parameters(apiResponses);
|
||||
}
|
||||
|
||||
public StructuralNode apply(StructuralNode serverSection, Map<String, ApiResponse> apiResponses) {
|
||||
return apply(serverSection, parameters(apiResponses));
|
||||
}
|
||||
|
||||
@Override
|
||||
public StructuralNode apply(StructuralNode serverSection, Parameters params) {
|
||||
Map<String, ApiResponse> apiResponses = params.apiResponses;
|
||||
|
||||
if (null == apiResponses || apiResponses.isEmpty()) return serverSection;
|
||||
|
||||
TableImpl pathResponsesTable = new TableImpl(serverSection, new HashMap<>(), new ArrayList<>());
|
||||
pathResponsesTable.setOption("header");
|
||||
pathResponsesTable.setAttribute("caption", "", true);
|
||||
pathResponsesTable.setAttribute("cols", ".^2a,.^14a,.^4a", true);
|
||||
pathResponsesTable.setTitle(labels.getLabel(TABLE_TITLE_RESPONSES));
|
||||
pathResponsesTable.setHeaderRow(
|
||||
labels.getLabel(TABLE_HEADER_HTTP_CODE),
|
||||
labels.getLabel(TABLE_HEADER_DESCRIPTION),
|
||||
labels.getLabel(TABLE_HEADER_LINKS));
|
||||
|
||||
apiResponses.forEach((httpCode, apiResponse) ->
|
||||
pathResponsesTable.addRow(
|
||||
generateInnerDoc(pathResponsesTable, httpCode),
|
||||
getResponseDescriptionColumnDocument(pathResponsesTable, apiResponse),
|
||||
linkComponent.apply(pathResponsesTable, apiResponse.getLinks())
|
||||
));
|
||||
serverSection.append(pathResponsesTable);
|
||||
return serverSection;
|
||||
}
|
||||
|
||||
private Document getResponseDescriptionColumnDocument(Table table, ApiResponse apiResponse) {
|
||||
Document document = generateInnerDoc(table, Optional.ofNullable(apiResponse.getDescription()).orElse(""));
|
||||
headersComponent.apply(document, apiResponse.getHeaders());
|
||||
mediaContentComponent.apply(document, apiResponse.getContent());
|
||||
return document;
|
||||
}
|
||||
|
||||
public static class Parameters {
|
||||
private final Map<String, ApiResponse> apiResponses;
|
||||
|
||||
public Parameters(Map<String, ApiResponse> apiResponses) {
|
||||
|
||||
this.apiResponses = apiResponses;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,118 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.internal.component;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter;
|
||||
import io.github.swagger2markup.adoc.ast.impl.DocumentImpl;
|
||||
import io.github.swagger2markup.adoc.ast.impl.ParagraphBlockImpl;
|
||||
import io.github.swagger2markup.extension.MarkupComponent;
|
||||
import io.github.swagger2markup.internal.helper.OpenApiHelpers;
|
||||
import io.swagger.v3.oas.models.media.Schema;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.asciidoctor.ast.Document;
|
||||
import org.asciidoctor.ast.StructuralNode;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import java.util.stream.Collectors;
|
||||
import java.util.stream.Stream;
|
||||
|
||||
import static io.github.swagger2markup.adoc.converter.internal.Delimiters.LINE_SEPARATOR;
|
||||
import static io.github.swagger2markup.config.OpenAPILabels.*;
|
||||
import static io.github.swagger2markup.internal.helper.OpenApiHelpers.boldUnconstrained;
|
||||
|
||||
public class SchemaComponent extends MarkupComponent<StructuralNode, SchemaComponent.Parameters, StructuralNode> {
|
||||
|
||||
private final OpenAPI2MarkupConverter.OpenAPIContext context;
|
||||
|
||||
public SchemaComponent(OpenAPI2MarkupConverter.OpenAPIContext context) {
|
||||
super(context);
|
||||
this.context = context;
|
||||
}
|
||||
|
||||
public static SchemaComponent.Parameters parameters(@SuppressWarnings("rawtypes") Schema schema) {
|
||||
return new SchemaComponent.Parameters(schema);
|
||||
}
|
||||
|
||||
public Document apply(StructuralNode parent, @SuppressWarnings("rawtypes") Schema schema) {
|
||||
return apply(parent, parameters(schema));
|
||||
}
|
||||
|
||||
@SuppressWarnings({"unchecked", "rawtypes"})
|
||||
@Override
|
||||
public Document apply(StructuralNode parent, SchemaComponent.Parameters parameters) {
|
||||
Document schemaDocument = new DocumentImpl(parent);
|
||||
Schema schema = parameters.schema;
|
||||
if (null == schema) return schemaDocument;
|
||||
|
||||
OpenApiHelpers.appendDescription(schemaDocument, schema.getDescription());
|
||||
|
||||
Map<String, Boolean> schemasBooleanProperties = new HashMap<String, Boolean>() {{
|
||||
put(labels.getLabel(LABEL_DEPRECATED), schema.getDeprecated());
|
||||
put(labels.getLabel(LABEL_NULLABLE), schema.getNullable());
|
||||
put(labels.getLabel(LABEL_READ_ONLY), schema.getReadOnly());
|
||||
put(labels.getLabel(LABEL_WRITE_ONLY), schema.getWriteOnly());
|
||||
put(labels.getLabel(LABEL_UNIQUE_ITEMS), schema.getUniqueItems());
|
||||
put(labels.getLabel(LABEL_EXCLUSIVE_MAXIMUM), schema.getExclusiveMaximum());
|
||||
put(labels.getLabel(LABEL_EXCLUSIVE_MINIMUM), schema.getExclusiveMinimum());
|
||||
}};
|
||||
|
||||
Map<String, Object> schemasValueProperties = new HashMap<String, Object>() {{
|
||||
put(labels.getLabel(LABEL_TITLE), schema.getTitle());
|
||||
put(labels.getLabel(LABEL_DEFAULT), schema.getDefault());
|
||||
put(labels.getLabel(LABEL_MAXIMUM), schema.getMaximum());
|
||||
put(labels.getLabel(LABEL_MINIMUM), schema.getMinimum());
|
||||
put(labels.getLabel(LABEL_MAX_LENGTH), schema.getMaxLength());
|
||||
put(labels.getLabel(LABEL_MIN_LENGTH), schema.getMinLength());
|
||||
put(labels.getLabel(LABEL_MAX_ITEMS), schema.getMaxItems());
|
||||
put(labels.getLabel(LABEL_MIN_ITEMS), schema.getMinItems());
|
||||
put(labels.getLabel(LABEL_MAX_PROPERTIES), schema.getMaxProperties());
|
||||
put(labels.getLabel(LABEL_MIN_PROPERTIES), schema.getMinProperties());
|
||||
put(labels.getLabel(LABEL_MULTIPLE_OF), schema.getMultipleOf());
|
||||
}};
|
||||
|
||||
Stream<String> schemaBooleanStream = schemasBooleanProperties.entrySet().stream()
|
||||
.filter(e -> null != e.getValue() && e.getValue())
|
||||
.map(e -> OpenApiHelpers.italicUnconstrained(e.getKey().toLowerCase()));
|
||||
Stream<String> schemaValueStream = schemasValueProperties.entrySet().stream()
|
||||
.filter(e -> null != e.getValue() && StringUtils.isNotBlank(e.getValue().toString()))
|
||||
.map(e -> boldUnconstrained(e.getKey()) + ": " + e.getValue());
|
||||
|
||||
ParagraphBlockImpl paragraphBlock = new ParagraphBlockImpl(schemaDocument);
|
||||
String source = Stream.concat(schemaBooleanStream, schemaValueStream).collect(Collectors.joining(" +" + LINE_SEPARATOR));
|
||||
paragraphBlock.setSource(source);
|
||||
|
||||
schemaDocument.append(paragraphBlock);
|
||||
|
||||
Map<String, Schema> properties = schema.getProperties();
|
||||
if (null != properties && !properties.isEmpty()) {
|
||||
PropertiesTableComponent propertiesTableComponent = new PropertiesTableComponent(context);
|
||||
propertiesTableComponent.apply(schemaDocument, properties, schema.getRequired());
|
||||
}
|
||||
|
||||
return schemaDocument;
|
||||
}
|
||||
|
||||
@SuppressWarnings("rawtypes")
|
||||
public static class Parameters {
|
||||
|
||||
private final Schema schema;
|
||||
|
||||
public Parameters(Schema schema) {
|
||||
this.schema = schema;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,86 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.internal.component;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter;
|
||||
import io.github.swagger2markup.adoc.ast.impl.TableImpl;
|
||||
import io.github.swagger2markup.extension.MarkupComponent;
|
||||
import io.swagger.v3.oas.models.security.SecurityRequirement;
|
||||
import org.asciidoctor.ast.StructuralNode;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
|
||||
import static io.github.swagger2markup.config.OpenAPILabels.*;
|
||||
import static io.github.swagger2markup.internal.helper.OpenApiHelpers.*;
|
||||
|
||||
public class SecurityRequirementTableComponent extends MarkupComponent<StructuralNode, SecurityRequirementTableComponent.Parameters, StructuralNode> {
|
||||
|
||||
public SecurityRequirementTableComponent(OpenAPI2MarkupConverter.OpenAPIContext context) {
|
||||
super(context);
|
||||
}
|
||||
|
||||
public static SecurityRequirementTableComponent.Parameters parameters(List<SecurityRequirement> securityRequirements, boolean addTitle) {
|
||||
return new SecurityRequirementTableComponent.Parameters(securityRequirements, addTitle);
|
||||
}
|
||||
|
||||
public StructuralNode apply(StructuralNode document, List<SecurityRequirement> securityRequirements, boolean addTitle) {
|
||||
return apply(document, parameters(securityRequirements, addTitle));
|
||||
}
|
||||
|
||||
@Override
|
||||
public StructuralNode apply(StructuralNode node, SecurityRequirementTableComponent.Parameters parameters) {
|
||||
List<SecurityRequirement> securityRequirements = parameters.securityRequirements;
|
||||
|
||||
if (securityRequirements == null || securityRequirements.isEmpty()) return node;
|
||||
|
||||
TableImpl securityRequirementsTable = new TableImpl(node, new HashMap<>(), new ArrayList<>());
|
||||
securityRequirementsTable.setOption("header");
|
||||
securityRequirementsTable.setAttribute("caption", "", true);
|
||||
securityRequirementsTable.setAttribute("cols", ".^3a,.^4a,.^13a", true);
|
||||
if (parameters.addTitle) {
|
||||
securityRequirementsTable.setTitle(labels.getLabel(TABLE_TITLE_SECURITY));
|
||||
}
|
||||
securityRequirementsTable.setHeaderRow(
|
||||
labels.getLabel(TABLE_HEADER_TYPE),
|
||||
labels.getLabel(TABLE_HEADER_NAME),
|
||||
labels.getLabel(TABLE_HEADER_SCOPES));
|
||||
|
||||
securityRequirements.forEach(securityRequirement ->
|
||||
securityRequirement.forEach((name, scopes) ->
|
||||
securityRequirementsTable.addRow(
|
||||
generateInnerDoc(securityRequirementsTable, boldUnconstrained(scopes.isEmpty() ? "apiKey" : "oauth2")),
|
||||
generateInnerDoc(securityRequirementsTable, name),
|
||||
generateInnerDoc(securityRequirementsTable, String.join(", ", scopes))
|
||||
)
|
||||
)
|
||||
);
|
||||
node.append(securityRequirementsTable);
|
||||
return node;
|
||||
}
|
||||
|
||||
public static class Parameters {
|
||||
|
||||
private final List<SecurityRequirement> securityRequirements;
|
||||
private final boolean addTitle;
|
||||
|
||||
public Parameters(List<SecurityRequirement> securityRequirements, boolean addTitle) {
|
||||
this.securityRequirements = securityRequirements;
|
||||
this.addTitle = addTitle;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,86 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.internal.component;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter;
|
||||
import io.github.swagger2markup.adoc.ast.impl.DescriptionListEntryImpl;
|
||||
import io.github.swagger2markup.adoc.ast.impl.DescriptionListImpl;
|
||||
import io.github.swagger2markup.adoc.ast.impl.ListItemImpl;
|
||||
import io.github.swagger2markup.adoc.ast.impl.SectionImpl;
|
||||
import io.github.swagger2markup.extension.MarkupComponent;
|
||||
import io.swagger.v3.oas.models.tags.Tag;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.asciidoctor.ast.Document;
|
||||
import org.asciidoctor.ast.Section;
|
||||
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
|
||||
import static io.github.swagger2markup.config.OpenAPILabels.SECTION_TITLE_TAGS;
|
||||
|
||||
|
||||
public class TagsComponent extends MarkupComponent<Document, TagsComponent.Parameters, Document> {
|
||||
|
||||
private final ExternalDocumentationComponent externalDocumentationComponent;
|
||||
|
||||
public TagsComponent(OpenAPI2MarkupConverter.OpenAPIContext context) {
|
||||
super(context);
|
||||
this.externalDocumentationComponent = new ExternalDocumentationComponent(context);
|
||||
}
|
||||
|
||||
public static TagsComponent.Parameters parameters(List<Tag> tags) {
|
||||
return new TagsComponent.Parameters(tags);
|
||||
}
|
||||
|
||||
public Document apply(Document document, List<Tag> tags) {
|
||||
return apply(document, parameters(tags));
|
||||
}
|
||||
|
||||
@Override
|
||||
public Document apply(Document document, TagsComponent.Parameters parameters) {
|
||||
List<Tag> openAPITags = parameters.tags;
|
||||
if (null == openAPITags || openAPITags.isEmpty()) return document;
|
||||
|
||||
Section tagsSection = new SectionImpl(document);
|
||||
tagsSection.setTitle(labels.getLabel(SECTION_TITLE_TAGS));
|
||||
|
||||
DescriptionListImpl tagsList = new DescriptionListImpl(tagsSection);
|
||||
openAPITags.forEach(tag -> {
|
||||
DescriptionListEntryImpl tagEntry = new DescriptionListEntryImpl(tagsList, Collections.singletonList(new ListItemImpl(tagsList, tag.getName())));
|
||||
String description = tag.getDescription();
|
||||
if(StringUtils.isNotBlank(description)){
|
||||
ListItemImpl tagDesc = new ListItemImpl(tagEntry, "");
|
||||
tagDesc.setSource(description);
|
||||
externalDocumentationComponent.apply(tagDesc, tag.getExternalDocs());
|
||||
tagEntry.setDescription(tagDesc);
|
||||
}
|
||||
tagsList.addEntry(tagEntry);
|
||||
});
|
||||
|
||||
tagsSection.append(tagsList);
|
||||
document.append(tagsSection);
|
||||
return document;
|
||||
}
|
||||
|
||||
public static class Parameters {
|
||||
|
||||
private final List<Tag> tags;
|
||||
|
||||
public Parameters(List<Tag> tags) {
|
||||
this.tags = tags;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,122 +0,0 @@
|
||||
package io.github.swagger2markup.internal.document;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter;
|
||||
import io.github.swagger2markup.adoc.ast.impl.SectionImpl;
|
||||
import io.github.swagger2markup.extension.MarkupComponent;
|
||||
import io.github.swagger2markup.internal.component.*;
|
||||
import io.swagger.v3.oas.models.Components;
|
||||
import io.swagger.v3.oas.models.headers.Header;
|
||||
import io.swagger.v3.oas.models.links.Link;
|
||||
import io.swagger.v3.oas.models.media.Schema;
|
||||
import io.swagger.v3.oas.models.parameters.Parameter;
|
||||
import io.swagger.v3.oas.models.responses.ApiResponse;
|
||||
import org.apache.commons.lang3.Validate;
|
||||
import org.asciidoctor.ast.Document;
|
||||
import org.asciidoctor.ast.Section;
|
||||
import org.asciidoctor.ast.StructuralNode;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
import static io.github.swagger2markup.config.OpenAPILabels.*;
|
||||
|
||||
public class ComponentsDocument extends MarkupComponent<Document, ComponentsDocument.Parameters, Document> {
|
||||
|
||||
private final ParametersComponent parametersComponent;
|
||||
private final ResponseComponent responseComponent;
|
||||
private final HeadersComponent headersComponent;
|
||||
private final SchemaComponent schemaComponent;
|
||||
private final LinkComponent linkComponent;
|
||||
|
||||
public ComponentsDocument(OpenAPI2MarkupConverter.OpenAPIContext context) {
|
||||
super(context);
|
||||
this.parametersComponent = new ParametersComponent(context);
|
||||
this.responseComponent = new ResponseComponent(context);
|
||||
this.headersComponent = new HeadersComponent(context);
|
||||
this.schemaComponent = new SchemaComponent(context);
|
||||
this.linkComponent = new LinkComponent(context);
|
||||
}
|
||||
|
||||
public static Parameters parameters(Components components) {
|
||||
return new Parameters(components);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Document apply(Document document, ComponentsDocument.Parameters parameters) {
|
||||
|
||||
appendComponentsSection(document, parameters.components);
|
||||
|
||||
return document;
|
||||
}
|
||||
|
||||
public static class Parameters {
|
||||
private final Components components;
|
||||
|
||||
public Parameters(Components components) {
|
||||
this.components = Validate.notNull(components, "Schema must not be null");
|
||||
}
|
||||
}
|
||||
|
||||
private void appendComponentsSection(Document document, Components components) {
|
||||
if (null == components) return;
|
||||
|
||||
Section componentsSection = new SectionImpl(document);
|
||||
componentsSection.setTitle(labels.getLabel(SECTION_TITLE_COMPONENTS));
|
||||
String componentSectionId = "_components";
|
||||
componentsSection.setId(componentSectionId);
|
||||
|
||||
appendComponentsSchemasSection(componentsSection, componentSectionId, components.getSchemas());
|
||||
Map<String, Parameter> parameters = components.getParameters();
|
||||
if (null != parameters && !parameters.isEmpty()) {
|
||||
appendSubSection(componentsSection, componentSectionId, parametersComponent, SECTION_TITLE_PARAMETERS,
|
||||
new ParametersComponent.Parameters(parameters));
|
||||
}
|
||||
Map<String, ApiResponse> responses = components.getResponses();
|
||||
if (null != responses && !responses.isEmpty()) {
|
||||
appendSubSection(componentsSection, componentSectionId, responseComponent, SECTION_TITLE_RESPONSES,
|
||||
new ResponseComponent.Parameters(responses));
|
||||
}
|
||||
Map<String, Header> headers = components.getHeaders();
|
||||
if (null != headers && !headers.isEmpty()) {
|
||||
appendSubSection(componentsSection, componentSectionId, headersComponent, SECTION_TITLE_HEADERS,
|
||||
new HeadersComponent.Parameters(headers));
|
||||
}
|
||||
Map<String, Link> links = components.getLinks();
|
||||
if (null != links && !links.isEmpty()) {
|
||||
appendSubSection(componentsSection, componentSectionId, linkComponent, SECTION_TITLE_LINKS,
|
||||
new LinkComponent.Parameters(links));
|
||||
}
|
||||
document.append(componentsSection);
|
||||
}
|
||||
|
||||
private void appendComponentsSchemasSection(
|
||||
Section componentsSection, String componentSectionId,
|
||||
@SuppressWarnings("rawtypes") Map<String, Schema> schemas) {
|
||||
if (null == schemas || schemas.isEmpty()) return;
|
||||
|
||||
SectionImpl schemasSection = new SectionImpl(componentsSection);
|
||||
String schemasSectionId = componentSectionId + "_schemas";
|
||||
schemasSection.setTitle(labels.getLabel(SECTION_TITLE_SCHEMAS));
|
||||
schemasSection.setId(schemasSectionId);
|
||||
schemas.forEach((name, schema) -> {
|
||||
String schemaDocumentId = schemasSectionId + "_" + name;
|
||||
Document schemaDocument = schemaComponent.apply(schemasSection, schema);
|
||||
schemaDocument.setTitle(name);
|
||||
schemaDocument.setId(schemaDocumentId);
|
||||
schemasSection.append(schemaDocument);
|
||||
});
|
||||
componentsSection.append(schemasSection);
|
||||
}
|
||||
|
||||
private <T> void appendSubSection(Section componentsSection, String componentSectionId,
|
||||
MarkupComponent<StructuralNode, T, StructuralNode> markupComponent,
|
||||
String sectionLabel, T parameters) {
|
||||
SectionImpl parametersSection = new SectionImpl(componentsSection);
|
||||
String parametersSectionId = componentSectionId + "_parameters";
|
||||
parametersSection.setTitle(labels.getLabel(sectionLabel));
|
||||
parametersSection.setId(parametersSectionId);
|
||||
markupComponent.apply(parametersSection, parameters);
|
||||
componentsSection.append(parametersSection);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -1,138 +0,0 @@
|
||||
package io.github.swagger2markup.internal.document;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter;
|
||||
import io.github.swagger2markup.adoc.ast.impl.BlockImpl;
|
||||
import io.github.swagger2markup.adoc.ast.impl.DocumentImpl;
|
||||
import io.github.swagger2markup.adoc.ast.impl.ParagraphBlockImpl;
|
||||
import io.github.swagger2markup.adoc.ast.impl.SectionImpl;
|
||||
import io.github.swagger2markup.extension.MarkupComponent;
|
||||
import io.github.swagger2markup.extension.OverviewDocumentExtension;
|
||||
import io.github.swagger2markup.internal.component.ExternalDocumentationComponent;
|
||||
import io.github.swagger2markup.internal.component.TagsComponent;
|
||||
import io.swagger.v3.oas.models.OpenAPI;
|
||||
import io.swagger.v3.oas.models.info.Contact;
|
||||
import io.swagger.v3.oas.models.info.Info;
|
||||
import io.swagger.v3.oas.models.info.License;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.apache.commons.lang3.Validate;
|
||||
import org.asciidoctor.ast.Block;
|
||||
import org.asciidoctor.ast.Document;
|
||||
import org.asciidoctor.ast.Section;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.HashMap;
|
||||
import java.util.Optional;
|
||||
|
||||
import static io.github.swagger2markup.config.OpenAPILabels.LABEL_TERMS_OF_SERVICE;
|
||||
import static io.github.swagger2markup.config.OpenAPILabels.SECTION_TITLE_OVERVIEW;
|
||||
import static io.github.swagger2markup.extension.OverviewDocumentExtension.Context;
|
||||
import static io.github.swagger2markup.internal.helper.OpenApiHelpers.appendDescription;
|
||||
|
||||
public class OverviewDocument extends MarkupComponent<Document, OverviewDocument.Parameters, Document> {
|
||||
private final TagsComponent tagsComponent;
|
||||
private final ExternalDocumentationComponent externalDocumentationComponent;
|
||||
|
||||
public OverviewDocument(OpenAPI2MarkupConverter.OpenAPIContext context) {
|
||||
super(context);
|
||||
tagsComponent = new TagsComponent(context);
|
||||
this.externalDocumentationComponent = new ExternalDocumentationComponent(context);
|
||||
}
|
||||
|
||||
public static OverviewDocument.Parameters parameters(OpenAPI schema) {
|
||||
return new OverviewDocument.Parameters(schema);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Document apply(Document document, Parameters parameters) {
|
||||
Info apiInfo = parameters.openAPI.getInfo();
|
||||
document.setAttribute("openapi", parameters.openAPI.getOpenapi(), true);
|
||||
addDocumentTitle(document, apiInfo);
|
||||
addAuthorInfo(document, apiInfo);
|
||||
addVersionInfo(document, apiInfo);
|
||||
|
||||
applyOverviewDocumentExtension(new Context(OverviewDocumentExtension.Position.DOCUMENT_BEFORE, document));
|
||||
Document subDocument = new DocumentImpl(document);
|
||||
Section overviewDoc = new SectionImpl(subDocument, "section", new HashMap<>(), new ArrayList<>(),
|
||||
null, new ArrayList<>(), 1, "", new ArrayList<>(),
|
||||
null, null, "", "", false, false);
|
||||
applyOverviewDocumentExtension(new Context(OverviewDocumentExtension.Position.DOCUMENT_BEGIN, subDocument));
|
||||
overviewDoc.setTitle(labels.getLabel(SECTION_TITLE_OVERVIEW));
|
||||
|
||||
appendDescription(overviewDoc, apiInfo.getDescription());
|
||||
appendTermsOfServiceInfo(overviewDoc, apiInfo);
|
||||
appendLicenseInfo(overviewDoc, apiInfo);
|
||||
subDocument.append(overviewDoc);
|
||||
applyOverviewDocumentExtension(new Context(OverviewDocumentExtension.Position.DOCUMENT_END, subDocument));
|
||||
document.append(subDocument);
|
||||
|
||||
externalDocumentationComponent.apply(document, parameters.openAPI.getExternalDocs());
|
||||
tagsComponent.apply(document, parameters.openAPI.getTags());
|
||||
applyOverviewDocumentExtension(new Context(OverviewDocumentExtension.Position.DOCUMENT_AFTER, document));
|
||||
return document;
|
||||
}
|
||||
|
||||
private void applyOverviewDocumentExtension(Context context) {
|
||||
extensionRegistry.getOverviewDocumentExtensions().forEach(extension -> extension.apply(context));
|
||||
}
|
||||
|
||||
private void addDocumentTitle(Document rootDocument, Info apiInfo) {
|
||||
String title = apiInfo.getTitle();
|
||||
if (StringUtils.isNotBlank(title)) {
|
||||
rootDocument.setTitle(title);
|
||||
}
|
||||
}
|
||||
|
||||
private void addVersionInfo(Document rootDocument, Info info) {
|
||||
String version = info.getVersion();
|
||||
if (StringUtils.isNotBlank(version)) {
|
||||
rootDocument.setAttribute("revnumber", version, true);
|
||||
}
|
||||
}
|
||||
|
||||
private void addAuthorInfo(Document rootDocument, Info info) {
|
||||
Contact contact = info.getContact();
|
||||
if (null != contact) {
|
||||
String author = Optional.ofNullable(contact.getName()).orElse("");
|
||||
String email = contact.getEmail();
|
||||
if (StringUtils.isNotBlank(email)) {
|
||||
rootDocument.setAttribute("email", email, true);
|
||||
}
|
||||
rootDocument.setAttribute("author", author, true);
|
||||
rootDocument.setAttribute("authorcount", 1L, true);
|
||||
}
|
||||
}
|
||||
|
||||
private void appendLicenseInfo(Section overviewDoc, Info info) {
|
||||
License license = info.getLicense();
|
||||
if (null != license) {
|
||||
StringBuilder sb = new StringBuilder();
|
||||
if (StringUtils.isNotBlank(license.getUrl())) {
|
||||
sb.append(license.getUrl()).append("[");
|
||||
}
|
||||
sb.append(license.getName());
|
||||
if (StringUtils.isNotBlank(license.getUrl())) {
|
||||
sb.append("]");
|
||||
}
|
||||
BlockImpl paragraph = new ParagraphBlockImpl(overviewDoc);
|
||||
paragraph.setSource(sb.toString());
|
||||
overviewDoc.append(paragraph);
|
||||
}
|
||||
}
|
||||
|
||||
private void appendTermsOfServiceInfo(Section overviewDoc, Info info) {
|
||||
String termsOfService = info.getTermsOfService();
|
||||
if (StringUtils.isNotBlank(termsOfService)) {
|
||||
Block paragraph = new ParagraphBlockImpl(overviewDoc);
|
||||
paragraph.setSource(termsOfService + "[" + labels.getLabel(LABEL_TERMS_OF_SERVICE) + "]");
|
||||
overviewDoc.append(paragraph);
|
||||
}
|
||||
}
|
||||
|
||||
public static class Parameters {
|
||||
private final OpenAPI openAPI;
|
||||
|
||||
public Parameters(OpenAPI openAPI) {
|
||||
this.openAPI = Validate.notNull(openAPI, "Schema must not be null");
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,116 +0,0 @@
|
||||
package io.github.swagger2markup.internal.document;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter;
|
||||
import io.github.swagger2markup.adoc.ast.impl.SectionImpl;
|
||||
import io.github.swagger2markup.adoc.ast.impl.TableImpl;
|
||||
import io.github.swagger2markup.extension.MarkupComponent;
|
||||
import io.github.swagger2markup.internal.component.ExternalDocumentationComponent;
|
||||
import io.github.swagger2markup.internal.component.ParametersComponent;
|
||||
import io.github.swagger2markup.internal.component.ResponseComponent;
|
||||
import io.github.swagger2markup.internal.component.SecurityRequirementTableComponent;
|
||||
import io.swagger.v3.oas.models.OpenAPI;
|
||||
import io.swagger.v3.oas.models.Paths;
|
||||
import io.swagger.v3.oas.models.servers.Server;
|
||||
import io.swagger.v3.oas.models.servers.ServerVariables;
|
||||
import org.apache.commons.lang3.Validate;
|
||||
import org.asciidoctor.ast.Document;
|
||||
import org.asciidoctor.ast.Section;
|
||||
import org.asciidoctor.ast.StructuralNode;
|
||||
|
||||
import java.util.*;
|
||||
|
||||
import static io.github.swagger2markup.config.OpenAPILabels.*;
|
||||
import static io.github.swagger2markup.internal.helper.OpenApiHelpers.*;
|
||||
|
||||
public class PathsDocument extends MarkupComponent<Document, PathsDocument.Parameters, Document> {
|
||||
private final ParametersComponent parametersComponent;
|
||||
private final ExternalDocumentationComponent externalDocumentationComponent;
|
||||
private final ResponseComponent responseComponent;
|
||||
private final SecurityRequirementTableComponent securityRequirementTableComponent;
|
||||
|
||||
public PathsDocument(OpenAPI2MarkupConverter.OpenAPIContext context) {
|
||||
super(context);
|
||||
this.parametersComponent = new ParametersComponent(context);
|
||||
this.externalDocumentationComponent = new ExternalDocumentationComponent(context);
|
||||
this.responseComponent = new ResponseComponent(context);
|
||||
this.securityRequirementTableComponent = new SecurityRequirementTableComponent(context);
|
||||
}
|
||||
|
||||
public static Parameters parameters(OpenAPI schema) {
|
||||
return new Parameters(schema);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Document apply(Document document, Parameters parameters) {
|
||||
Paths apiPaths = parameters.schema.getPaths();
|
||||
|
||||
if (null == apiPaths || apiPaths.isEmpty()) return document;
|
||||
|
||||
SectionImpl allPathsSection = new SectionImpl(document);
|
||||
allPathsSection.setTitle(labels.getLabel(SECTION_TITLE_PATHS));
|
||||
|
||||
apiPaths.forEach((name, pathItem) ->
|
||||
pathItem.readOperationsMap().forEach(((httpMethod, operation) -> {
|
||||
SectionImpl operationSection = new SectionImpl(allPathsSection);
|
||||
String summary = Optional.ofNullable(operation.getSummary()).orElse("");
|
||||
operationSection.setTitle((italicUnconstrained(httpMethod.name().toUpperCase()) + " " + monospaced(name) + " " + summary).trim());
|
||||
appendDescription(operationSection, operation.getDescription());
|
||||
externalDocumentationComponent.apply(operationSection, operation.getExternalDocs());
|
||||
parametersComponent.apply(operationSection, operation.getParameters());
|
||||
responseComponent.apply(operationSection, operation.getResponses());
|
||||
appendServersSection(operationSection, operation.getServers());
|
||||
securityRequirementTableComponent.apply(operationSection, operation.getSecurity(), false);
|
||||
allPathsSection.append(operationSection);
|
||||
})));
|
||||
|
||||
document.append(allPathsSection);
|
||||
return document;
|
||||
}
|
||||
|
||||
private void appendServersSection(StructuralNode node, List<Server> servers) {
|
||||
if (null == servers || servers.isEmpty()) return;
|
||||
|
||||
Section serversSection = new SectionImpl(node);
|
||||
serversSection.setTitle(labels.getLabel(SECTION_TITLE_SERVERS));
|
||||
|
||||
servers.forEach(server -> {
|
||||
Section serverSection = new SectionImpl(serversSection);
|
||||
serverSection.setTitle(italicUnconstrained(labels.getLabel(LABEL_SERVER)) + ": " + server.getUrl());
|
||||
|
||||
appendDescription(serverSection, server.getDescription());
|
||||
ServerVariables variables = server.getVariables();
|
||||
appendVariables(serverSection, variables);
|
||||
serversSection.append(serverSection);
|
||||
});
|
||||
node.append(serversSection);
|
||||
}
|
||||
|
||||
private void appendVariables(Section serverSection, ServerVariables variables) {
|
||||
if (null == variables || variables.isEmpty()) return;
|
||||
|
||||
TableImpl serverVariables = new TableImpl(serverSection, new HashMap<String, Object>() {{
|
||||
put("header-option", "");
|
||||
put("cols", ".^2a,.^9a,.^3a,.^4a");
|
||||
}}, new ArrayList<>());
|
||||
serverVariables.setTitle(labels.getLabel(TABLE_TITLE_SERVER_VARIABLES));
|
||||
|
||||
serverVariables.setHeaderRow(labels.getLabel(TABLE_HEADER_VARIABLE), labels.getLabel(TABLE_HEADER_DESCRIPTION),
|
||||
labels.getLabel(TABLE_HEADER_POSSIBLE_VALUES), labels.getLabel(TABLE_HEADER_DEFAULT)
|
||||
);
|
||||
|
||||
variables.forEach((name, variable) -> {
|
||||
String possibleValues = String.join(", ", Optional.ofNullable(variable.getEnum()).orElse(Collections.singletonList("Any")));
|
||||
serverVariables.addRow(name, Optional.ofNullable(variable.getDescription()).orElse(""), possibleValues, variable.getDefault());
|
||||
|
||||
});
|
||||
serverSection.append(serverVariables);
|
||||
}
|
||||
|
||||
public static class Parameters {
|
||||
private final OpenAPI schema;
|
||||
|
||||
public Parameters(OpenAPI schema) {
|
||||
this.schema = Validate.notNull(schema, "Schema must not be null");
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,49 +0,0 @@
|
||||
package io.github.swagger2markup.internal.document;
|
||||
|
||||
import io.github.swagger2markup.OpenAPI2MarkupConverter;
|
||||
import io.github.swagger2markup.adoc.ast.impl.SectionImpl;
|
||||
import io.github.swagger2markup.extension.MarkupComponent;
|
||||
import io.github.swagger2markup.internal.component.SecurityRequirementTableComponent;
|
||||
import io.swagger.v3.oas.models.OpenAPI;
|
||||
import io.swagger.v3.oas.models.security.SecurityRequirement;
|
||||
import org.apache.commons.lang3.Validate;
|
||||
import org.asciidoctor.ast.Document;
|
||||
import org.asciidoctor.ast.Section;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import static io.github.swagger2markup.config.OpenAPILabels.SECTION_TITLE_SECURITY;
|
||||
|
||||
public class SecurityDocument extends MarkupComponent<Document, SecurityDocument.Parameters, Document> {
|
||||
private final SecurityRequirementTableComponent securityRequirementTableComponent;
|
||||
|
||||
public SecurityDocument(OpenAPI2MarkupConverter.OpenAPIContext context) {
|
||||
super(context);
|
||||
this.securityRequirementTableComponent = new SecurityRequirementTableComponent(context);
|
||||
}
|
||||
|
||||
public static Parameters parameters(OpenAPI schema) {
|
||||
return new Parameters(schema);
|
||||
}
|
||||
|
||||
@Override
|
||||
public Document apply(Document document, SecurityDocument.Parameters parameters) {
|
||||
List<SecurityRequirement> securityRequirements = parameters.schema.getSecurity();
|
||||
if (null == securityRequirements || securityRequirements.isEmpty()) return document;
|
||||
|
||||
Section securityRequirementsSection = new SectionImpl(document);
|
||||
securityRequirementsSection.setTitle(labels.getLabel(SECTION_TITLE_SECURITY));
|
||||
securityRequirementTableComponent.apply(securityRequirementsSection, securityRequirements, false);
|
||||
document.append(securityRequirementsSection);
|
||||
|
||||
return document;
|
||||
}
|
||||
|
||||
public static class Parameters {
|
||||
private final OpenAPI schema;
|
||||
|
||||
public Parameters(OpenAPI schema) {
|
||||
this.schema = Validate.notNull(schema, "Schema must not be null");
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,115 +0,0 @@
|
||||
package io.github.swagger2markup.internal.helper;
|
||||
|
||||
import io.github.swagger2markup.adoc.ast.impl.DocumentImpl;
|
||||
import io.github.swagger2markup.adoc.ast.impl.ParagraphBlockImpl;
|
||||
import io.swagger.v3.oas.models.media.ArraySchema;
|
||||
import io.swagger.v3.oas.models.media.Schema;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.asciidoctor.ast.Block;
|
||||
import org.asciidoctor.ast.Document;
|
||||
import org.asciidoctor.ast.StructuralNode;
|
||||
import org.asciidoctor.ast.Table;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
import static io.github.swagger2markup.adoc.converter.internal.Delimiters.LINE_SEPARATOR;
|
||||
|
||||
public class OpenApiHelpers {
|
||||
|
||||
public static void appendDescription(StructuralNode node, String description) {
|
||||
if (StringUtils.isNotBlank(description)) {
|
||||
Block paragraph = new ParagraphBlockImpl(node);
|
||||
paragraph.setSource(description);
|
||||
node.append(paragraph);
|
||||
}
|
||||
}
|
||||
|
||||
public static Document generateInnerDoc(Table table, String documentContent) {
|
||||
return generateInnerDoc(table, documentContent, "");
|
||||
}
|
||||
|
||||
public static Document generateInnerDoc(Table table, String documentContent, String id) {
|
||||
Document innerDoc = new DocumentImpl(table);
|
||||
if (StringUtils.isNotBlank(id)) {
|
||||
innerDoc.setId(id);
|
||||
}
|
||||
|
||||
Block paragraph = new ParagraphBlockImpl(innerDoc);
|
||||
paragraph.setSource(documentContent);
|
||||
innerDoc.append(paragraph);
|
||||
return innerDoc;
|
||||
}
|
||||
|
||||
public static String requiredIndicator(boolean isRequired, String labelRequired, String labelOptional) {
|
||||
return italicUnconstrained(isRequired ? labelRequired : labelOptional).toLowerCase();
|
||||
}
|
||||
|
||||
public static String superScript(String str) {
|
||||
return "^" + str + "^";
|
||||
}
|
||||
|
||||
public static String subScript(String str) {
|
||||
return "~" + str + "~";
|
||||
}
|
||||
|
||||
public static String italicUnconstrained(String str) {
|
||||
return "__" + str + "__";
|
||||
}
|
||||
|
||||
public static String boldUnconstrained(String str) {
|
||||
return "**" + str + "**";
|
||||
}
|
||||
|
||||
public static String monospaced(String str) {
|
||||
return "`" + str + "`";
|
||||
}
|
||||
|
||||
public static String getSchemaTypeAsString(Schema schema) {
|
||||
StringBuilder stringBuilder = new StringBuilder();
|
||||
if (schema instanceof ArraySchema) {
|
||||
stringBuilder.append("< ");
|
||||
Schema<?> items = ((ArraySchema) schema).getItems();
|
||||
stringBuilder.append(getSchemaType(items));
|
||||
stringBuilder.append(" > ");
|
||||
stringBuilder.append(schema.getType());
|
||||
} else {
|
||||
List enumList = schema.getEnum();
|
||||
if (enumList != null) {
|
||||
stringBuilder.append("enum (");
|
||||
for (Object value : enumList) {
|
||||
stringBuilder.append(value.toString());
|
||||
stringBuilder.append(",");
|
||||
}
|
||||
stringBuilder.deleteCharAt(stringBuilder.length() - 1);
|
||||
stringBuilder.append(')');
|
||||
} else {
|
||||
stringBuilder.append(getSchemaType(schema));
|
||||
String format = schema.getFormat();
|
||||
if (format != null) {
|
||||
stringBuilder.append(' ');
|
||||
stringBuilder.append('(');
|
||||
stringBuilder.append(format);
|
||||
stringBuilder.append(')');
|
||||
}
|
||||
}
|
||||
}
|
||||
return stringBuilder.toString();
|
||||
}
|
||||
|
||||
private static String getSchemaType(Schema<?> schema) {
|
||||
String type = schema.getType();
|
||||
if (StringUtils.isNotEmpty(type)) {
|
||||
return type;
|
||||
} else {
|
||||
return generateRefLink(schema.get$ref());
|
||||
}
|
||||
}
|
||||
|
||||
private static String generateRefLink(String ref) {
|
||||
if (StringUtils.isNotBlank(ref)) {
|
||||
String anchor = ref.toLowerCase().replaceFirst("#", "").replaceAll("/", "_");
|
||||
return "<<" + anchor + ">>" + LINE_SEPARATOR;
|
||||
}
|
||||
return "";
|
||||
}
|
||||
}
|
||||
@@ -1,43 +0,0 @@
|
||||
swagger2markup.markupLanguage=ASCIIDOC
|
||||
swagger2markup.swaggerMarkupLanguage=ASCIIDOC
|
||||
swagger2markup.hostnameEnabled=false
|
||||
swagger2markup.basePathPrefixEnabled=false
|
||||
swagger2markup.operationExtensionsEnabled=false
|
||||
swagger2markup.definitionExtensionsEnabled=false
|
||||
swagger2markup.separatedDefinitionsEnabled=false
|
||||
swagger2markup.separatedOperationsEnabled=false
|
||||
swagger2markup.pathsGroupedBy=AS_IS
|
||||
swagger2markup.outputLanguage=EN
|
||||
swagger2markup.inlineSchemaEnabled=true
|
||||
swagger2markup.interDocumentCrossReferencesEnabled=false
|
||||
swagger2markup.flatBodyEnabled=false
|
||||
swagger2markup.pathSecuritySectionEnabled=true
|
||||
swagger2markup.overviewDocument=overview
|
||||
swagger2markup.pathsDocument=paths
|
||||
swagger2markup.definitionsDocument=definitions
|
||||
swagger2markup.securityDocument=security
|
||||
swagger2markup.separatedOperationsFolder=operations
|
||||
swagger2markup.separatedDefinitionsFolder=definitions
|
||||
swagger2markup.tagOrderBy=NATURAL
|
||||
swagger2markup.operationOrderBy=NATURAL
|
||||
swagger2markup.definitionOrderBy=NATURAL
|
||||
swagger2markup.parameterOrderBy=NATURAL
|
||||
swagger2markup.propertyOrderBy=NATURAL
|
||||
swagger2markup.responseOrderBy=NATURAL
|
||||
swagger2markup.listDelimiterEnabled=false
|
||||
swagger2markup.listDelimiter=,
|
||||
swagger2markup.asciidoc.pegdown.timeoutMillis=2000
|
||||
|
||||
swagger2markup.generatedExamplesEnabled=false
|
||||
# basic, curl, invoke-webrequest
|
||||
swagger2markup.requestExamplesFormat=basic
|
||||
# default, bash, powershell, etc.
|
||||
swagger2markup.requestExamplesSourceFormat=default
|
||||
# hide, inherit or hostname
|
||||
swagger2markup.requestExamplesHost=hide
|
||||
# hide, inherit or schema (e.g. https, https, etc.)
|
||||
swagger2markup.requestExamplesSchema=hide
|
||||
swagger2markup.requestExamplesHideBasePath=true
|
||||
swagger2markup.requestExamplesIncludeAllQueryParams=false
|
||||
# single, commaSeparated, multiple, multiple[]
|
||||
swagger2markup.requestExamplesQueryArrayStyle=single
|
||||
@@ -1,58 +0,0 @@
|
||||
label_content=Content
|
||||
label_default=Default
|
||||
label_deprecated=Deprecated
|
||||
label_example=Example
|
||||
label_examples=Examples
|
||||
label_exclusive_maximum=Exclusive Maximum
|
||||
label_exclusive_minimum=Exclusive Minimum
|
||||
label_external_value=External Value
|
||||
label_format=Format
|
||||
label_maximum=Maximum
|
||||
label_max_items=Maximum Items
|
||||
label_max_length=Maximum Length
|
||||
label_max_properties=Maximum Properties
|
||||
label_minimum=Minimum
|
||||
label_min_items=Minimum Items
|
||||
label_min_length=Minimum Length
|
||||
label_min_properties=Minimum Properties
|
||||
label_multiple_of=Multiple Of
|
||||
label_no_links=No Links
|
||||
label_nullable=Nullable
|
||||
label_operation=Operation
|
||||
label_optional=Optional
|
||||
label_parameters=Parameters
|
||||
label_read_only=Read Only
|
||||
label_required=Required
|
||||
label_server=Server
|
||||
label_terms_of_service=Terms Of Service
|
||||
label_title=Title
|
||||
label_type=Type
|
||||
label_unique_items=Unique Items
|
||||
label_write_only=Write Only
|
||||
section_title_components=Components
|
||||
section_title_parameters=Parameters
|
||||
section_title_paths=Paths
|
||||
section_title_schemas=Schemas
|
||||
section_title_security=Security
|
||||
section_title_servers=Servers
|
||||
section_title_overview=Overview
|
||||
section_title_tags=Tags
|
||||
section_title_responses=Responses
|
||||
section_title_headers=Headers
|
||||
section_title_links=Links
|
||||
table_header_default=Default
|
||||
table_header_description=Description
|
||||
table_header_http_code=Code
|
||||
table_header_links=Links
|
||||
table_header_name=Name
|
||||
table_header_possible_values=Possible Values
|
||||
table_header_schema=Schema
|
||||
table_header_scopes=Scopes
|
||||
table_header_type=Type
|
||||
table_header_variable=Variable
|
||||
table_title_headers=Headers
|
||||
table_title_parameters=Parameters
|
||||
table_title_properties=Properties
|
||||
table_title_responses=Responses
|
||||
table_title_security=Security
|
||||
table_title_server_variables=Server Variables
|
||||
@@ -1,74 +0,0 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup;
|
||||
|
||||
import io.github.swagger2markup.assertions.DiffUtils;
|
||||
import org.apache.commons.io.FileUtils;
|
||||
import org.assertj.core.api.Assertions;
|
||||
import org.junit.Before;
|
||||
import org.junit.Test;
|
||||
|
||||
import java.net.URISyntaxException;
|
||||
import java.nio.file.Path;
|
||||
import java.nio.file.Paths;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
import static java.util.Arrays.asList;
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
public class AsciidocConverterTest {
|
||||
|
||||
private static final String[] EXPECTED_FILES = new String[]{"definitions.adoc", "overview.adoc", "paths.adoc", "security.adoc"};
|
||||
private List<String> expectedFiles;
|
||||
|
||||
@Before
|
||||
public void setUp() {
|
||||
expectedFiles = new ArrayList<>(asList(EXPECTED_FILES));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testToString() throws URISyntaxException {
|
||||
//Given
|
||||
Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
|
||||
|
||||
//When
|
||||
String asciiDocAsString = OpenAPI2MarkupConverter.from(file).build()
|
||||
.toString();
|
||||
//Then
|
||||
Assertions.assertThat(asciiDocAsString).isNotEmpty();
|
||||
System.out.println(asciiDocAsString);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testToFolder() throws URISyntaxException {
|
||||
//Given
|
||||
Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
|
||||
Path outputDirectory = Paths.get("build/test/asciidoc/to_folder");
|
||||
FileUtils.deleteQuietly(outputDirectory.toFile());
|
||||
|
||||
//When
|
||||
OpenAPI2MarkupConverter.from(file).build()
|
||||
.toFolder(outputDirectory);
|
||||
|
||||
//Then
|
||||
String[] files = outputDirectory.toFile().list();
|
||||
assertThat(files).hasSize(4).containsAll(expectedFiles);
|
||||
|
||||
Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected/asciidoc/to_folder").toURI());
|
||||
DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testToFolder.html");
|
||||
}
|
||||
}
|
||||
@@ -1,49 +0,0 @@
|
||||
package io.github.swagger2markup;
|
||||
|
||||
import io.swagger.v3.oas.models.OpenAPI;
|
||||
import io.swagger.v3.parser.OpenAPIV3Parser;
|
||||
import io.swagger.v3.parser.core.models.ParseOptions;
|
||||
import io.swagger.v3.parser.core.models.SwaggerParseResult;
|
||||
import org.apache.commons.io.IOUtils;
|
||||
import org.junit.Test;
|
||||
import org.junit.runner.RunWith;
|
||||
import org.junit.runners.Parameterized;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.nio.file.Paths;
|
||||
import java.util.Arrays;
|
||||
|
||||
import static org.junit.Assert.assertNotNull;
|
||||
|
||||
@RunWith(Parameterized.class)
|
||||
public class OpenApi2AsciiDocTest {
|
||||
|
||||
final private String openApiFile;
|
||||
final private String expectedAsciiDoc;
|
||||
|
||||
public OpenApi2AsciiDocTest(String openApiFile, String expectedAsciiDoc) throws IOException {
|
||||
this.openApiFile = "./src/test/resources/open_api/" + openApiFile;
|
||||
this.expectedAsciiDoc = IOUtils.toString(getClass().getResourceAsStream("/asciidoc/" + expectedAsciiDoc), StandardCharsets.UTF_8);
|
||||
}
|
||||
|
||||
@Parameterized.Parameters(name = "Run {index}: open api={0}, asciidoc={1}")
|
||||
public static Iterable<Object[]> data() {
|
||||
return Arrays.asList(new Object[][]{
|
||||
{"simple.yaml", "simple.adoc"},
|
||||
{"petstore.yaml", "petstore.adoc"}
|
||||
});
|
||||
}
|
||||
|
||||
@Test
|
||||
public void converts_open_api_v3_to_asciidoc() {
|
||||
ParseOptions options = new ParseOptions();
|
||||
options.setResolve(true);
|
||||
SwaggerParseResult result = new OpenAPIV3Parser().readLocation(openApiFile, null, options);
|
||||
OpenAPI swagger = result.getOpenAPI();
|
||||
assertNotNull(swagger);
|
||||
|
||||
OpenAPI2MarkupConverter converter = OpenAPI2MarkupConverter.from(swagger).build();
|
||||
converter.toFolder(Paths.get("build/test/asciidoc"));
|
||||
}
|
||||
}
|
||||
@@ -1,55 +0,0 @@
|
||||
/*
|
||||
*
|
||||
* Copyright 2017 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
*
|
||||
*/
|
||||
package io.github.swagger2markup.assertions;
|
||||
|
||||
import io.github.robwin.diff.DiffAssertions;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.nio.file.DirectoryStream;
|
||||
import java.nio.file.Files;
|
||||
import java.nio.file.Path;
|
||||
import java.nio.file.Paths;
|
||||
|
||||
public class DiffUtils {
|
||||
|
||||
private static final Logger LOGGER = LoggerFactory.getLogger(DiffUtils.class);
|
||||
|
||||
public static void assertThatAllFilesAreEqual(Path expectedDirectory, Path actualDirectory, String reportName) {
|
||||
Path reportPath = Paths.get("build/diff-report/", reportName);
|
||||
try {
|
||||
try (DirectoryStream<Path> directoryStream = Files.newDirectoryStream(expectedDirectory)) {
|
||||
for (Path expectedFile : directoryStream) {
|
||||
Path actualFile = actualDirectory.resolve(expectedFile.getFileName());
|
||||
LOGGER.info("Diffing file '{}' with '{}'", actualFile, expectedFile);
|
||||
DiffAssertions.assertThat(actualFile).isEqualTo(expectedFile, reportPath);
|
||||
}
|
||||
}
|
||||
} catch (IOException e) {
|
||||
throw new RuntimeException("Failed to assert that all files are equal", e);
|
||||
}
|
||||
}
|
||||
|
||||
public static void assertThatFileIsEqual(Path expectedFile, Path actualFile, String reportName) {
|
||||
Path reportPath = Paths.get("build/diff-report/", reportName);
|
||||
LOGGER.info("Diffing file '{}' with '{}'", actualFile, expectedFile);
|
||||
DiffAssertions.assertThat(actualFile).isEqualTo(expectedFile, reportPath);
|
||||
}
|
||||
}
|
||||
@@ -1,276 +0,0 @@
|
||||
= Simple Inventory API
|
||||
<you@your-company.com>
|
||||
v1.0.0
|
||||
:revnumber: 1.0.0
|
||||
:openapi: 3.0.0
|
||||
:authorcount: 1
|
||||
:email: you@your-company.com
|
||||
|
||||
== Overview
|
||||
This is a simple API
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0]
|
||||
|
||||
== Tags
|
||||
admins::
|
||||
Secured Admin-only calls
|
||||
developers::
|
||||
Operations available to regular developers
|
||||
|
||||
== Servers
|
||||
=== __Server__: /
|
||||
|
||||
== Paths
|
||||
=== __GET__ `/inventory` searches inventory
|
||||
By passing in the appropriate options, you can search for
|
||||
available inventory in the system
|
||||
|
||||
.Parameters
|
||||
[%header,caption=,cols=".^2a,.^3a,.^10a,.^5a"]
|
||||
|===
|
||||
<.<|Type
|
||||
|
||||
|
||||
<.<|Name
|
||||
|
||||
|
||||
<.<|Description
|
||||
|
||||
|
||||
<.<|Schema
|
||||
|
||||
|
||||
|
||||
<.<|**query**
|
||||
|
||||
|
||||
<.<|**searchString** +
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|pass an optional search string for looking up inventory
|
||||
|
||||
|
||||
<.<|type: string
|
||||
|
||||
|
||||
|
||||
<.<|**query**
|
||||
|
||||
|
||||
<.<|**limit** +
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|maximum number of records to return
|
||||
|
||||
|
||||
<.<|minimum: 0 +
|
||||
type: integer +
|
||||
maximum: 50 +
|
||||
format: int32
|
||||
|
||||
|
||||
|
||||
<.<|**query**
|
||||
|
||||
|
||||
<.<|**skip** +
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|number of records to skip for pagination
|
||||
|
||||
|
||||
<.<|minimum: 0 +
|
||||
type: integer +
|
||||
format: int32
|
||||
|
||||
|
||||
|
||||
|===
|
||||
.Responses
|
||||
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
<.<|Code
|
||||
|
||||
|
||||
<.<|Description
|
||||
|
||||
|
||||
<.<|Links
|
||||
|
||||
|
||||
|
||||
<.<|200
|
||||
|
||||
|
||||
<.<|search results matching criteria
|
||||
|
||||
.Content
|
||||
application/json::
|
||||
+
|
||||
|
||||
type: array
|
||||
|
||||
|
||||
<.<|No Links
|
||||
|
||||
|
||||
|
||||
<.<|400
|
||||
|
||||
|
||||
<.<|bad input parameter
|
||||
|
||||
|
||||
<.<|No Links
|
||||
|
||||
|
||||
|
||||
|===
|
||||
|
||||
=== __POST__ `/inventory` adds an inventory item
|
||||
Adds an item to the system
|
||||
|
||||
.Responses
|
||||
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
<.<|Code
|
||||
|
||||
|
||||
<.<|Description
|
||||
|
||||
|
||||
<.<|Links
|
||||
|
||||
|
||||
|
||||
<.<|201
|
||||
|
||||
|
||||
<.<|item created
|
||||
|
||||
|
||||
<.<|No Links
|
||||
|
||||
|
||||
|
||||
<.<|400
|
||||
|
||||
|
||||
<.<|invalid input, object invalid
|
||||
|
||||
|
||||
<.<|No Links
|
||||
|
||||
|
||||
|
||||
<.<|409
|
||||
|
||||
|
||||
<.<|an existing item already exists
|
||||
|
||||
|
||||
<.<|No Links
|
||||
|
||||
|
||||
|
||||
|===
|
||||
|
||||
[[_components]]
|
||||
== Components
|
||||
[[_components_schemas]]
|
||||
=== Schemas
|
||||
[[_components_schemas_inventoryitem]]
|
||||
==== InventoryItem
|
||||
|
||||
type: object
|
||||
|
||||
.Properties
|
||||
[%header,caption=,cols=".^4a,.^16a"]
|
||||
|===
|
||||
<.<|Name
|
||||
|
||||
|
||||
<.<|Schema
|
||||
|
||||
|
||||
|
||||
<.<|id
|
||||
__required__
|
||||
|
||||
|
||||
<.<|type: string +
|
||||
format: uuid
|
||||
|
||||
|
||||
|
||||
<.<|name
|
||||
__required__
|
||||
|
||||
|
||||
<.<|type: string
|
||||
|
||||
|
||||
|
||||
<.<|releaseDate
|
||||
__required__
|
||||
|
||||
|
||||
<.<|type: string +
|
||||
format: date-time
|
||||
|
||||
|
||||
|
||||
<.<|manufacturer
|
||||
__required__
|
||||
|
||||
|
||||
<.<|<<_components_schemas_Manufacturer,Manufacturer>>
|
||||
|
||||
|
||||
|
||||
|===
|
||||
[[_components_schemas_manufacturer]]
|
||||
==== Manufacturer
|
||||
|
||||
type: object
|
||||
|
||||
.Properties
|
||||
[%header,caption=,cols=".^4a,.^16a"]
|
||||
|===
|
||||
<.<|Name
|
||||
|
||||
|
||||
<.<|Schema
|
||||
|
||||
|
||||
|
||||
<.<|name
|
||||
__required__
|
||||
|
||||
|
||||
<.<|type: string
|
||||
|
||||
|
||||
|
||||
<.<|homePage
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|type: string +
|
||||
format: url
|
||||
|
||||
|
||||
|
||||
<.<|phone
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|type: string
|
||||
|
||||
|
||||
|
||||
|===
|
||||
|
||||
@@ -1,351 +0,0 @@
|
||||
|
||||
[[_components]]
|
||||
== Components
|
||||
[[_components_schemas]]
|
||||
=== Schemas
|
||||
[[_components_schemas_user]]
|
||||
==== User
|
||||
|
||||
.Properties
|
||||
[%header,caption=,cols=".^4a,.^16a,.^4a"]
|
||||
|===
|
||||
<.<|Name
|
||||
|
||||
|
||||
<.<|Description
|
||||
|
||||
|
||||
<.<|Schema
|
||||
|
||||
|
||||
|
||||
<.<|id
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|integer (int64)
|
||||
|
||||
|
||||
|
||||
<.<|username
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|string
|
||||
|
||||
|
||||
|
||||
<.<|firstName
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|string
|
||||
|
||||
|
||||
|
||||
<.<|lastName
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|string
|
||||
|
||||
|
||||
|
||||
<.<|email
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|string
|
||||
|
||||
|
||||
|
||||
<.<|password
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|string
|
||||
|
||||
|
||||
|
||||
<.<|phone
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|string
|
||||
|
||||
|
||||
|
||||
<.<|userStatus
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|User Status
|
||||
|
||||
|
||||
<.<|integer (int32)
|
||||
|
||||
|
||||
|
||||
|===
|
||||
[[_components_schemas_category]]
|
||||
==== Category
|
||||
|
||||
.Properties
|
||||
[%header,caption=,cols=".^4a,.^16a,.^4a"]
|
||||
|===
|
||||
<.<|Name
|
||||
|
||||
|
||||
<.<|Description
|
||||
|
||||
|
||||
<.<|Schema
|
||||
|
||||
|
||||
|
||||
<.<|id
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|integer (int64)
|
||||
|
||||
|
||||
|
||||
<.<|name
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|The name of the category
|
||||
|
||||
**Maximum Length**: 255 +
|
||||
**Minimum Length**: 0 +
|
||||
**Default**: DefaultCategory
|
||||
|
||||
|
||||
<.<|string
|
||||
|
||||
|
||||
|
||||
|===
|
||||
[[_components_schemas_pet]]
|
||||
==== Pet
|
||||
|
||||
.Properties
|
||||
[%header,caption=,cols=".^4a,.^16a,.^4a"]
|
||||
|===
|
||||
<.<|Name
|
||||
|
||||
|
||||
<.<|Description
|
||||
|
||||
|
||||
<.<|Schema
|
||||
|
||||
|
||||
|
||||
<.<|id
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|integer (int64)
|
||||
|
||||
|
||||
|
||||
<.<|category
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|<<_components_schemas_category>>
|
||||
|
||||
|
||||
|
||||
<.<|name
|
||||
__required__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|string
|
||||
|
||||
|
||||
|
||||
<.<|photoUrls
|
||||
__required__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|< string > array
|
||||
|
||||
|
||||
|
||||
<.<|tags
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|< <<_components_schemas_tag>>
|
||||
> array
|
||||
|
||||
|
||||
|
||||
<.<|status
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|pet status in the store,
|
||||
|
||||
|
||||
<.<|enum (Dead,Alive)
|
||||
|
||||
|
||||
|
||||
|===
|
||||
[[_components_schemas_tag]]
|
||||
==== Tag
|
||||
|
||||
.Properties
|
||||
[%header,caption=,cols=".^4a,.^16a,.^4a"]
|
||||
|===
|
||||
<.<|Name
|
||||
|
||||
|
||||
<.<|Description
|
||||
|
||||
|
||||
<.<|Schema
|
||||
|
||||
|
||||
|
||||
<.<|id
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|integer (int64)
|
||||
|
||||
|
||||
|
||||
<.<|name
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|string
|
||||
|
||||
|
||||
|
||||
|===
|
||||
[[_components_schemas_order]]
|
||||
==== Order
|
||||
|
||||
.Properties
|
||||
[%header,caption=,cols=".^4a,.^16a,.^4a"]
|
||||
|===
|
||||
<.<|Name
|
||||
|
||||
|
||||
<.<|Description
|
||||
|
||||
|
||||
<.<|Schema
|
||||
|
||||
|
||||
|
||||
<.<|id
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|integer (int64)
|
||||
|
||||
|
||||
|
||||
<.<|petId
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|integer (int64)
|
||||
|
||||
|
||||
|
||||
<.<|quantity
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|**Maximum**: 10000 +
|
||||
**Minimum**: 0 +
|
||||
**Default**: 0
|
||||
|
||||
|
||||
<.<|integer (int32)
|
||||
|
||||
|
||||
|
||||
<.<|shipDate
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|string (date-time)
|
||||
|
||||
|
||||
|
||||
<.<|status
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|Order Status
|
||||
|
||||
|
||||
<.<|enum (Ordered,Cancelled)
|
||||
|
||||
|
||||
|
||||
<.<|complete
|
||||
__optional__
|
||||
|
||||
|
||||
<.<|
|
||||
<.<|boolean
|
||||
|
||||
|
||||
|
||||
|===
|
||||
|
||||
[[_components_parameters]]
|
||||
=== Responses
|
||||
.Responses
|
||||
[%header,caption=,cols=".^2a,.^14a,.^4a"]
|
||||
|===
|
||||
<.<|Code
|
||||
|
||||
|
||||
<.<|Description
|
||||
|
||||
|
||||
<.<|Links
|
||||
|
||||
|
||||
|
||||
<.<|InvalidId
|
||||
|
||||
|
||||
<.<|Invalid ID supplied
|
||||
|
||||
|
||||
<.<|No Links
|
||||
|
||||
|
||||
|
||||
|===
|
||||
|
||||
@@ -1,30 +0,0 @@
|
||||
= Swagger Petstore
|
||||
apiteam@swagger.io
|
||||
v1.0.0
|
||||
:revnumber: 1.0.0
|
||||
:openapi: 3.0.0
|
||||
:author: apiteam@swagger.io
|
||||
:authorcount: 1
|
||||
|
||||
|
||||
== Overview
|
||||
This is a sample server Petstore server.
|
||||
|
||||
[Learn about Swagger](http://swagger.io) 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
|
||||
|
||||
http://helloreverb.com/terms/[Terms Of Service]
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0]
|
||||
|
||||
http://swagger.io[Find out more about Swagger]
|
||||
|
||||
== Tags
|
||||
pet::
|
||||
Pet resource
|
||||
store::
|
||||
Store resource
|
||||
user::
|
||||
User resource
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
|
||||
@@ -1,14 +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>
|
||||
|
||||
<logger name="io.github.swagger2markup" level="DEBUG"/>
|
||||
|
||||
<root level="INFO">
|
||||
<appender-ref ref="CONSOLE" />
|
||||
</root>
|
||||
</configuration>
|
||||
@@ -1,732 +0,0 @@
|
||||
openapi: 3.0.0
|
||||
servers:
|
||||
- url: 'http://localhost:8000/v2/api'
|
||||
info:
|
||||
description: >-
|
||||
This is a sample server Petstore server. You can find out more about
|
||||
Swagger at http://swagger.io or on
|
||||
irc.freenode.net, #swagger. For this sample, you can use the api key
|
||||
"special-key" to test the authorization filters
|
||||
version: 1.0.0
|
||||
title: Swagger Petstore
|
||||
termsOfService: 'http://swagger.io/terms/'
|
||||
contact:
|
||||
name: apiteam@swagger.io
|
||||
license:
|
||||
name: Apache 2.0
|
||||
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
|
||||
externalDocs:
|
||||
description: Find more info here
|
||||
url: 'https://swagger.io'
|
||||
tags:
|
||||
- name: pet
|
||||
description: Pet Operations
|
||||
externalDocs:
|
||||
url: 'http://swagger.io'
|
||||
- name: user
|
||||
description: All about the Users
|
||||
paths:
|
||||
/pet/add:
|
||||
post:
|
||||
tags:
|
||||
- pet
|
||||
summary: Add a new pet to the store
|
||||
description: ''
|
||||
operationId: createPet
|
||||
responses:
|
||||
'200':
|
||||
description: This is a sample
|
||||
content:
|
||||
text/plain:
|
||||
schema:
|
||||
type: string
|
||||
example: 'whoa!'
|
||||
'405':
|
||||
description: Invalid input
|
||||
security:
|
||||
- petstore_auth:
|
||||
- 'write:pets'
|
||||
- 'read:pets'
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
description: Pet object that needs to be added to the store
|
||||
/pet:
|
||||
post:
|
||||
tags:
|
||||
- pet
|
||||
summary: Add a new pet to the store
|
||||
description: ''
|
||||
operationId: addPet
|
||||
responses:
|
||||
'405':
|
||||
description: Invalid input
|
||||
security:
|
||||
- petstore_auth:
|
||||
- 'write:pets'
|
||||
- 'read:pets'
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
description: Pet object that needs to be added to the store
|
||||
put:
|
||||
tags:
|
||||
- pet
|
||||
summary: Update an existing pet
|
||||
description: ''
|
||||
operationId: updatePet
|
||||
responses:
|
||||
'400':
|
||||
description: Invalid ID supplied
|
||||
'404':
|
||||
description: Pet not found
|
||||
'405':
|
||||
description: Validation exception
|
||||
security:
|
||||
- petstore_auth:
|
||||
- 'write:pets'
|
||||
- 'read:pets'
|
||||
requestBody:
|
||||
$ref: '#/components/requestBodies/Pet'
|
||||
/pet/findByStatus:
|
||||
get:
|
||||
tags:
|
||||
- pet
|
||||
summary: Finds Pets by status
|
||||
description: Multiple status values can be provided with comma seperated strings
|
||||
operationId: findPetsByStatus
|
||||
parameters:
|
||||
- name: status
|
||||
in: query
|
||||
description: Status values that need to be considered for filter
|
||||
required: false
|
||||
style: pipeDelimited
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
default: available
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/PetArray'
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: '#/components/schemas/PetArray'
|
||||
'400':
|
||||
description: Invalid status value
|
||||
security:
|
||||
- petstore_auth:
|
||||
- 'write:pets'
|
||||
- 'read:pets'
|
||||
/pet/findByTags:
|
||||
get:
|
||||
tags:
|
||||
- pet
|
||||
summary: Finds Pets by tags
|
||||
description: >-
|
||||
Muliple tags can be provided with comma seperated strings. Use tag1,
|
||||
tag2, tag3 for testing.
|
||||
operationId: findPetsByTags
|
||||
parameters:
|
||||
- name: tags
|
||||
in: query
|
||||
description: Tags to filter by
|
||||
required: false
|
||||
explode: true
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
application/xml:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
'400':
|
||||
description: Invalid tag value
|
||||
security:
|
||||
- petstore_auth:
|
||||
- 'write:pets'
|
||||
- 'read:pets'
|
||||
'/pet/{petId}':
|
||||
get:
|
||||
tags:
|
||||
- pet
|
||||
summary: Find pet by ID
|
||||
description: >-
|
||||
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API
|
||||
error conditions
|
||||
operationId: getPetById
|
||||
parameters:
|
||||
- name: petId
|
||||
in: path
|
||||
description: ID of pet that needs to be fetched
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
'400':
|
||||
description: Invalid ID supplied
|
||||
'404':
|
||||
description: Pet not found
|
||||
security:
|
||||
- api_key: []
|
||||
- petstore_auth:
|
||||
- 'write:pets'
|
||||
- 'read:pets'
|
||||
post:
|
||||
tags:
|
||||
- pet
|
||||
summary: Updates a pet in the store with form data
|
||||
description: ''
|
||||
operationId: updatePetWithForm
|
||||
parameters:
|
||||
- name: petId
|
||||
in: path
|
||||
description: ID of pet that needs to be updated
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'405':
|
||||
description: Invalid input
|
||||
security:
|
||||
- petstore_auth:
|
||||
- 'write:pets'
|
||||
- 'read:pets'
|
||||
requestBody:
|
||||
content:
|
||||
application/x-www-form-urlencoded:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
description: Updated name of the pet
|
||||
type: string
|
||||
status:
|
||||
description: Updated status of the pet
|
||||
type: string
|
||||
delete:
|
||||
tags:
|
||||
- pet
|
||||
summary: Deletes a pet
|
||||
description: ''
|
||||
operationId: deletePet
|
||||
parameters:
|
||||
- name: api_key
|
||||
in: header
|
||||
description: ''
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
- name: petId
|
||||
in: path
|
||||
description: Pet id to delete
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
responses:
|
||||
'400':
|
||||
description: Invalid pet value
|
||||
security:
|
||||
- petstore_auth:
|
||||
- 'write:pets'
|
||||
- 'read:pets'
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
description: Pet extra params that needs to be deleted
|
||||
'/pet/{petId}/uploadImage':
|
||||
post:
|
||||
tags:
|
||||
- pet
|
||||
summary: uploads an image
|
||||
description: ''
|
||||
operationId: uploadFile
|
||||
parameters:
|
||||
- name: petId
|
||||
in: path
|
||||
description: ID of pet to update
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ApiResponse"
|
||||
security:
|
||||
- petstore_auth:
|
||||
- 'write:pets'
|
||||
- 'read:pets'
|
||||
requestBody:
|
||||
content:
|
||||
multipart/form-data:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
additionalMetadata:
|
||||
description: Additional data to pass to server
|
||||
type: string
|
||||
file:
|
||||
description: file to upload
|
||||
type: string
|
||||
format: binary
|
||||
/store/inventory:
|
||||
get:
|
||||
tags:
|
||||
- store
|
||||
summary: Returns pet inventories by status
|
||||
description: Returns a map of status codes to quantities
|
||||
operationId: get inventory+1
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
additionalProperties:
|
||||
type: integer
|
||||
format: int32
|
||||
application/xml:
|
||||
schema:
|
||||
type: object
|
||||
additionalProperties:
|
||||
type: integer
|
||||
format: int32
|
||||
security:
|
||||
- api_key: []
|
||||
/store/order:
|
||||
post:
|
||||
tags:
|
||||
- store
|
||||
summary: Place an order for a pet
|
||||
description: ''
|
||||
operationId: placeOrder
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Order'
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Order'
|
||||
'400':
|
||||
description: Invalid Order
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Order'
|
||||
description: order placed for purchasing the pet
|
||||
'/store/order/{orderId}':
|
||||
get:
|
||||
tags:
|
||||
- store
|
||||
summary: Find purchase order by ID
|
||||
description: >-
|
||||
For valid response try integer IDs with value <= 5 or > 10. Other values
|
||||
will generated exceptions
|
||||
operationId: getOrderById
|
||||
parameters:
|
||||
- name: orderId
|
||||
in: path
|
||||
description: ID of pet that needs to be fetched
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Order'
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Order'
|
||||
'400':
|
||||
description: Invalid ID supplied
|
||||
'404':
|
||||
description: Order not found
|
||||
delete:
|
||||
tags:
|
||||
- store
|
||||
summary: Delete purchase order by ID
|
||||
description: >-
|
||||
For valid response try integer IDs with value < 1000. Anything above
|
||||
1000 or nonintegers will generate API errors
|
||||
operationId: deleteOrder
|
||||
parameters:
|
||||
- name: orderId
|
||||
in: path
|
||||
description: ID of the order that needs to be deleted
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'400':
|
||||
description: Invalid ID supplied
|
||||
'404':
|
||||
description: Order not found
|
||||
/user:
|
||||
post:
|
||||
tags:
|
||||
- user
|
||||
summary: Create user
|
||||
description: This can only be done by the logged in user.
|
||||
operationId: createUser
|
||||
responses:
|
||||
200:
|
||||
content:
|
||||
'application/json':
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
# default is text/plain
|
||||
type: string
|
||||
format: text
|
||||
examples:
|
||||
foo:
|
||||
value: {"foo": "bar"}
|
||||
bar:
|
||||
summary: A bar example
|
||||
value: {"bar": "baz"}
|
||||
default:
|
||||
description: successful operation
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/User'
|
||||
description: Created user object
|
||||
/user/createWithArray:
|
||||
post:
|
||||
tags:
|
||||
- user
|
||||
summary: Creates list of users with given input array
|
||||
description: ''
|
||||
operationId: createUsersWithArrayInput
|
||||
responses:
|
||||
default:
|
||||
description: successful operation
|
||||
requestBody:
|
||||
$ref: '#/components/requestBodies/UserArray'
|
||||
/user/createWithList:
|
||||
post:
|
||||
tags:
|
||||
- user
|
||||
summary: Creates list of users with given input array
|
||||
description: ''
|
||||
operationId: createUsersWithListInput
|
||||
responses:
|
||||
default:
|
||||
description: successful operation
|
||||
requestBody:
|
||||
$ref: '#/components/requestBodies/UserArray'
|
||||
/user/login:
|
||||
get:
|
||||
tags:
|
||||
- user
|
||||
security:
|
||||
- https
|
||||
summary: Logs user into the system
|
||||
description: ''
|
||||
operationId: loginUser
|
||||
parameters:
|
||||
- name: username
|
||||
in: query
|
||||
description: The user name for login
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
- name: password
|
||||
in: query
|
||||
description: The password for login in clear text
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: string
|
||||
application/xml:
|
||||
schema:
|
||||
type: string
|
||||
'400':
|
||||
description: Invalid username/password supplied
|
||||
/user/logout:
|
||||
get:
|
||||
tags:
|
||||
- user
|
||||
security:
|
||||
- https
|
||||
summary: Logs out current logged in user session
|
||||
description: ''
|
||||
operationId: logoutUser
|
||||
responses:
|
||||
default:
|
||||
description: successful operation
|
||||
'/user/{username}':
|
||||
get:
|
||||
tags:
|
||||
- user
|
||||
summary: Get user by user name
|
||||
description: ''
|
||||
operationId: getUserByName
|
||||
parameters:
|
||||
- name: username
|
||||
in: path
|
||||
description: 'The name that needs to be fetched. Use user1 for testing.'
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/User'
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: '#/components/schemas/User'
|
||||
'400':
|
||||
description: Invalid username supplied
|
||||
'404':
|
||||
description: User not found
|
||||
put:
|
||||
tags:
|
||||
- user
|
||||
summary: Updated user
|
||||
description: This can only be done by the logged in user.
|
||||
operationId: updateUser
|
||||
parameters:
|
||||
- name: username
|
||||
in: path
|
||||
description: name that need to be deleted
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'400':
|
||||
description: Invalid user supplied
|
||||
'404':
|
||||
description: User not found
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/User'
|
||||
description: Updated user object
|
||||
delete:
|
||||
tags:
|
||||
- user
|
||||
summary: Delete user
|
||||
description: This can only be done by the logged in user.
|
||||
operationId: deleteUser
|
||||
parameters:
|
||||
- name: username
|
||||
in: path
|
||||
description: The name that needs to be deleted
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'400':
|
||||
description: Invalid username supplied
|
||||
'404':
|
||||
description: User not found
|
||||
security:
|
||||
- foo:
|
||||
- bar
|
||||
- baz
|
||||
a:
|
||||
- b
|
||||
- c
|
||||
components:
|
||||
parameters:
|
||||
sharedSkip:
|
||||
name: skip
|
||||
in: query
|
||||
description: Results to skip
|
||||
required: false
|
||||
schema:
|
||||
type: integer
|
||||
format: int32
|
||||
responses:
|
||||
veryBad:
|
||||
description: failed
|
||||
requestBodies:
|
||||
UserArray:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/User'
|
||||
description: List of user object
|
||||
Pet:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
description: Pet object that needs to be added to the store
|
||||
securitySchemes:
|
||||
api_key:
|
||||
type: apiKey
|
||||
name: api_key
|
||||
in: header
|
||||
petstore_auth:
|
||||
type: oauth2
|
||||
flows:
|
||||
implicit:
|
||||
authorizationUrl: 'http://petstore.swagger.io/api/oauth/dialog'
|
||||
scopes:
|
||||
'write:pets': modify pets in your account
|
||||
'read:pets': read your pets
|
||||
schemas:
|
||||
User:
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
username:
|
||||
type: string
|
||||
firstName:
|
||||
type: string
|
||||
lastName:
|
||||
type: string
|
||||
email:
|
||||
type: string
|
||||
password:
|
||||
type: string
|
||||
phone:
|
||||
type: string
|
||||
userStatus:
|
||||
type: integer
|
||||
format: int32
|
||||
description: User Status
|
||||
xml:
|
||||
name: User
|
||||
Category:
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
name:
|
||||
type: string
|
||||
xml:
|
||||
name: Category
|
||||
Pet:
|
||||
required:
|
||||
- name
|
||||
- photoUrls
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
category:
|
||||
$ref: '#/components/schemas/Category'
|
||||
name:
|
||||
type: string
|
||||
example: doggie
|
||||
photoUrls:
|
||||
type: array
|
||||
xml:
|
||||
name: photoUrl
|
||||
wrapped: true
|
||||
items:
|
||||
type: string
|
||||
tags:
|
||||
type: array
|
||||
xml:
|
||||
name: tag
|
||||
wrapped: true
|
||||
items:
|
||||
$ref: '#/components/schemas/Tag'
|
||||
status:
|
||||
type: string
|
||||
description: pet status in the store
|
||||
xml:
|
||||
name: Pet
|
||||
Tag:
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
name:
|
||||
type: string
|
||||
xml:
|
||||
name: Tag
|
||||
Order:
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
petId:
|
||||
type: integer
|
||||
format: int64
|
||||
quantity:
|
||||
type: integer
|
||||
format: int32
|
||||
shipDate:
|
||||
type: string
|
||||
format: date-time
|
||||
status:
|
||||
type: string
|
||||
description: Order Status
|
||||
complete:
|
||||
type: boolean
|
||||
xml:
|
||||
name: Order
|
||||
PetArray:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
@@ -1,115 +0,0 @@
|
||||
openapi: 3.0.0
|
||||
info:
|
||||
description: This is a simple API
|
||||
version: "1.0.0"
|
||||
title: Simple Inventory API
|
||||
contact:
|
||||
email: you@your-company.com
|
||||
license:
|
||||
name: Apache 2.0
|
||||
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
|
||||
tags:
|
||||
- name: admins
|
||||
description: Secured Admin-only calls
|
||||
- name: developers
|
||||
description: Operations available to regular developers
|
||||
paths:
|
||||
/inventory:
|
||||
get:
|
||||
tags:
|
||||
- developers
|
||||
summary: searches inventory
|
||||
operationId: searchInventory
|
||||
description: |
|
||||
By passing in the appropriate options, you can search for
|
||||
available inventory in the system
|
||||
parameters:
|
||||
- in: query
|
||||
name: searchString
|
||||
description: pass an optional search string for looking up inventory
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: skip
|
||||
description: number of records to skip for pagination
|
||||
schema:
|
||||
type: integer
|
||||
format: int32
|
||||
minimum: 0
|
||||
- in: query
|
||||
name: limit
|
||||
description: maximum number of records to return
|
||||
schema:
|
||||
type: integer
|
||||
format: int32
|
||||
minimum: 0
|
||||
maximum: 50
|
||||
responses:
|
||||
'200':
|
||||
description: search results matching criteria
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/InventoryItem'
|
||||
'400':
|
||||
description: bad input parameter
|
||||
post:
|
||||
tags:
|
||||
- admins
|
||||
summary: adds an inventory item
|
||||
operationId: addInventory
|
||||
description: Adds an item to the system
|
||||
responses:
|
||||
'201':
|
||||
description: item created
|
||||
'400':
|
||||
description: 'invalid input, object invalid'
|
||||
'409':
|
||||
description: an existing item already exists
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/InventoryItem'
|
||||
description: Inventory item to add
|
||||
components:
|
||||
schemas:
|
||||
InventoryItem:
|
||||
type: object
|
||||
required:
|
||||
- id
|
||||
- name
|
||||
- manufacturer
|
||||
- releaseDate
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
format: uuid
|
||||
example: d290f1ee-6c54-4b01-90e6-d701748f0851
|
||||
name:
|
||||
type: string
|
||||
example: Widget Adapter
|
||||
releaseDate:
|
||||
type: string
|
||||
format: date-time
|
||||
example: '2016-08-29T09:12:33.001Z'
|
||||
manufacturer:
|
||||
$ref: '#/components/schemas/Manufacturer'
|
||||
Manufacturer:
|
||||
required:
|
||||
- name
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
example: ACME Corporation
|
||||
homePage:
|
||||
type: string
|
||||
format: url
|
||||
example: 'https://www.acme-corp.com'
|
||||
phone:
|
||||
type: string
|
||||
example: 408-867-5309
|
||||
type: object
|
||||
@@ -1,693 +0,0 @@
|
||||
openapi: 3.0.0
|
||||
info:
|
||||
description: >
|
||||
This is a sample server Petstore server.
|
||||
|
||||
|
||||
[Learn about Swagger](http://swagger.io) or join the IRC channel `#swagger` on irc.freenode.net.
|
||||
|
||||
|
||||
For this sample, you can use the api key `special-key` to test the authorization filters
|
||||
version: 1.0.0
|
||||
title: Swagger Petstore
|
||||
termsOfService: http://helloreverb.com/terms/
|
||||
contact:
|
||||
name: apiteam@swagger.io
|
||||
license:
|
||||
name: Apache 2.0
|
||||
url: http://www.apache.org/licenses/LICENSE-2.0.html
|
||||
tags:
|
||||
- name: pet
|
||||
description: Pet resource
|
||||
- name: store
|
||||
description: Store resource
|
||||
- name: user
|
||||
description: User resource
|
||||
paths:
|
||||
/pets:
|
||||
post:
|
||||
tags:
|
||||
- pet
|
||||
summary: Add a new pet to the store
|
||||
description: ""
|
||||
operationId: addPet
|
||||
requestBody:
|
||||
$ref: "#/components/requestBodies/Pet"
|
||||
responses:
|
||||
"405":
|
||||
description: Invalid input
|
||||
security:
|
||||
- petstore_auth:
|
||||
- write_pets
|
||||
- read_pets
|
||||
put:
|
||||
tags:
|
||||
- pet
|
||||
summary: Update an existing pet
|
||||
description: ""
|
||||
operationId: updatePet
|
||||
requestBody:
|
||||
$ref: "#/components/requestBodies/Pet"
|
||||
responses:
|
||||
"400":
|
||||
$ref: "#/components/responses/InvalidId"
|
||||
"404":
|
||||
description: Pet not found
|
||||
"405":
|
||||
description: Validation exception
|
||||
security:
|
||||
- petstore_auth:
|
||||
- write_pets
|
||||
- read_pets
|
||||
/pets/findByStatus:
|
||||
get:
|
||||
tags:
|
||||
- pet
|
||||
summary: Finds Pets by status
|
||||
description: Multiple status values can be provided with comma seperated strings
|
||||
operationId: findPetsByStatus
|
||||
parameters:
|
||||
- in: query
|
||||
name: status
|
||||
description: Status values that need to be considered for filter
|
||||
required: false
|
||||
explode: true
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
responses:
|
||||
"200":
|
||||
description: successful operation
|
||||
headers:
|
||||
X-Rate-Limit-Limit:
|
||||
description: The number of allowed requests in the current period
|
||||
schema:
|
||||
type: integer
|
||||
X-Rate-Limit-Remaining:
|
||||
description: The number of remaining requests in the current period
|
||||
schema:
|
||||
type: integer
|
||||
X-Rate-Limit-Reset:
|
||||
description: The number of seconds left in the current period
|
||||
schema:
|
||||
type: integer
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Pet"
|
||||
application/xml:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Pet"
|
||||
"400":
|
||||
description: Invalid status value
|
||||
security:
|
||||
- petstore_auth:
|
||||
- write_pets
|
||||
- read_pets
|
||||
/pets/findByTags:
|
||||
get:
|
||||
tags:
|
||||
- pet
|
||||
summary: Finds Pets by tags
|
||||
description: Muliple tags can be provided with comma seperated strings. Use tag1,
|
||||
tag2, tag3 for testing.
|
||||
operationId: findPetsByTags
|
||||
parameters:
|
||||
- in: query
|
||||
name: tags
|
||||
description: Tags to filter by
|
||||
required: false
|
||||
example: adorable
|
||||
explode: true
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
responses:
|
||||
"200":
|
||||
description: successful operation
|
||||
headers:
|
||||
X-Rate-Limit-Limit:
|
||||
description: The number of allowed requests in the current period
|
||||
schema:
|
||||
type: integer
|
||||
X-Rate-Limit-Remaining:
|
||||
description: The number of remaining requests in the current period
|
||||
schema:
|
||||
type: integer
|
||||
X-Rate-Limit-Reset:
|
||||
description: The number of seconds left in the current period
|
||||
schema:
|
||||
type: integer
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Pet"
|
||||
application/xml:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Pet"
|
||||
"400":
|
||||
description: Invalid tag value
|
||||
security:
|
||||
- petstore_auth:
|
||||
- write_pets
|
||||
- read_pets
|
||||
"/pets/{petId}":
|
||||
get:
|
||||
tags:
|
||||
- pet
|
||||
summary: Find pet by ID
|
||||
description: Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API
|
||||
error conditions
|
||||
operationId: getPetById
|
||||
parameters:
|
||||
- in: path
|
||||
name: petId
|
||||
description: ID of pet that needs to be fetched
|
||||
required: true
|
||||
example: 30
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
responses:
|
||||
"200":
|
||||
description: successful operation
|
||||
headers:
|
||||
X-Rate-Limit-Limit:
|
||||
description: The number of allowed requests in the current period
|
||||
schema:
|
||||
type: integer
|
||||
X-Rate-Limit-Remaining:
|
||||
description: The number of remaining requests in the current period
|
||||
schema:
|
||||
type: integer
|
||||
X-Rate-Limit-Reset:
|
||||
description: The number of seconds left in the current period
|
||||
schema:
|
||||
type: integer
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Pet"
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Pet"
|
||||
"400":
|
||||
$ref: "#/components/responses/InvalidId"
|
||||
"404":
|
||||
description: Pet not found
|
||||
security:
|
||||
- api_key: []
|
||||
- petstore_auth:
|
||||
- write_pets
|
||||
- read_pets
|
||||
post:
|
||||
tags:
|
||||
- pet
|
||||
summary: Updates a pet in the store with form data
|
||||
description: ""
|
||||
operationId: updatePetWithForm
|
||||
parameters:
|
||||
- in: path
|
||||
name: petId
|
||||
description: ID of pet that needs to be updated
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/x-www-form-urlencoded:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
description: Updated name of the pet
|
||||
type: string
|
||||
status:
|
||||
description: Updated status of the pet
|
||||
type: string
|
||||
required:
|
||||
- name
|
||||
- status
|
||||
responses:
|
||||
"405":
|
||||
description: Invalid input
|
||||
security:
|
||||
- petstore_auth:
|
||||
- write_pets
|
||||
- read_pets
|
||||
delete:
|
||||
tags:
|
||||
- pet
|
||||
summary: Deletes a pet
|
||||
description: ""
|
||||
operationId: deletePet
|
||||
parameters:
|
||||
- in: header
|
||||
name: api_key
|
||||
description: ""
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- in: path
|
||||
name: petId
|
||||
description: Pet id to delete
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
responses:
|
||||
"400":
|
||||
description: Invalid pet value
|
||||
security:
|
||||
- petstore_auth:
|
||||
- write_pets
|
||||
- read_pets
|
||||
/stores/order:
|
||||
post:
|
||||
tags:
|
||||
- store
|
||||
summary: Place an order for a pet
|
||||
description: ""
|
||||
operationId: placeOrder
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Order"
|
||||
description: order placed for purchasing the pet
|
||||
responses:
|
||||
"200":
|
||||
description: successful operation
|
||||
headers:
|
||||
X-Rate-Limit-Limit:
|
||||
description: The number of allowed requests in the current period
|
||||
schema:
|
||||
type: integer
|
||||
X-Rate-Limit-Remaining:
|
||||
description: The number of remaining requests in the current period
|
||||
schema:
|
||||
type: integer
|
||||
X-Rate-Limit-Reset:
|
||||
description: The number of seconds left in the current period
|
||||
schema:
|
||||
type: integer
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Order"
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Order"
|
||||
"400":
|
||||
description: Invalid Order
|
||||
"/stores/order/{orderId}":
|
||||
get:
|
||||
tags:
|
||||
- store
|
||||
summary: Find purchase order by ID
|
||||
description: For valid response try integer IDs with value <= 5 or > 10. Other values
|
||||
will generated exceptions
|
||||
operationId: getOrderById
|
||||
parameters:
|
||||
- in: path
|
||||
name: orderId
|
||||
description: ID of pet that needs to be fetched
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
"200":
|
||||
description: successful operation
|
||||
headers:
|
||||
X-Rate-Limit-Limit:
|
||||
description: The number of allowed requests in the current period
|
||||
schema:
|
||||
type: integer
|
||||
X-Rate-Limit-Remaining:
|
||||
description: The number of remaining requests in the current period
|
||||
schema:
|
||||
type: integer
|
||||
X-Rate-Limit-Reset:
|
||||
description: The number of seconds left in the current period
|
||||
schema:
|
||||
type: integer
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Order"
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Order"
|
||||
"400":
|
||||
$ref: "#/components/responses/InvalidId"
|
||||
"404":
|
||||
description: Order not found
|
||||
delete:
|
||||
tags:
|
||||
- store
|
||||
summary: Delete purchase order by ID
|
||||
description: For valid response try integer IDs with value < 1000. Anything above
|
||||
1000 or nonintegers will generate API errors
|
||||
operationId: deleteOrder
|
||||
parameters:
|
||||
- in: path
|
||||
name: orderId
|
||||
description: ID of the order that needs to be deleted
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
"400":
|
||||
$ref: "#/components/responses/InvalidId"
|
||||
"404":
|
||||
description: Order not found
|
||||
/users:
|
||||
post:
|
||||
tags:
|
||||
- user
|
||||
summary: Create user
|
||||
description: This can only be done by the logged in user.
|
||||
operationId: createUser
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/User"
|
||||
description: Created user object
|
||||
responses:
|
||||
default:
|
||||
description: successful operation
|
||||
/users/createWithArray:
|
||||
post:
|
||||
tags:
|
||||
- user
|
||||
summary: Creates list of users with given input array
|
||||
description: ""
|
||||
operationId: createUsersWithArrayInput
|
||||
requestBody:
|
||||
$ref: "#/components/requestBodies/UserArray"
|
||||
responses:
|
||||
default:
|
||||
description: successful operation
|
||||
/users/createWithList:
|
||||
post:
|
||||
tags:
|
||||
- user
|
||||
summary: Creates list of users with given input array
|
||||
description: ""
|
||||
operationId: createUsersWithListInput
|
||||
requestBody:
|
||||
$ref: "#/components/requestBodies/UserArray"
|
||||
responses:
|
||||
default:
|
||||
description: successful operation
|
||||
/users/login:
|
||||
get:
|
||||
tags:
|
||||
- user
|
||||
summary: Logs user into the system
|
||||
description: ""
|
||||
operationId: loginUser
|
||||
parameters:
|
||||
- in: query
|
||||
name: username
|
||||
description: The user name for login
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: password
|
||||
description: The password for login in clear text
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
"200":
|
||||
description: successful operation
|
||||
headers:
|
||||
X-Rate-Limit-Limit:
|
||||
description: The number of allowed requests in the current period
|
||||
schema:
|
||||
type: integer
|
||||
X-Rate-Limit-Remaining:
|
||||
description: The number of remaining requests in the current period
|
||||
schema:
|
||||
type: integer
|
||||
X-Rate-Limit-Reset:
|
||||
description: The number of seconds left in the current period
|
||||
schema:
|
||||
type: integer
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: string
|
||||
application/xml:
|
||||
schema:
|
||||
type: string
|
||||
"400":
|
||||
description: Invalid username/password supplied
|
||||
/users/logout:
|
||||
get:
|
||||
tags:
|
||||
- user
|
||||
summary: Logs out current logged in user session
|
||||
description: ""
|
||||
operationId: logoutUser
|
||||
responses:
|
||||
default:
|
||||
description: successful operation
|
||||
"/users/{username}":
|
||||
get:
|
||||
tags:
|
||||
- user
|
||||
summary: Get user by user name
|
||||
description: ""
|
||||
operationId: getUserByName
|
||||
parameters:
|
||||
- in: path
|
||||
name: username
|
||||
description: The name that needs to be fetched. Use user1 for testing.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
"200":
|
||||
description: successful operation
|
||||
headers:
|
||||
X-Rate-Limit-Limit:
|
||||
description: The number of allowed requests in the current period
|
||||
schema:
|
||||
type: integer
|
||||
X-Rate-Limit-Remaining:
|
||||
description: The number of remaining requests in the current period
|
||||
schema:
|
||||
type: integer
|
||||
X-Rate-Limit-Reset:
|
||||
description: The number of seconds left in the current period
|
||||
schema:
|
||||
type: integer
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/User"
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: "#/components/schemas/User"
|
||||
"400":
|
||||
description: Invalid username supplied
|
||||
"404":
|
||||
description: User not found
|
||||
put:
|
||||
tags:
|
||||
- user
|
||||
summary: Updated user
|
||||
description: This can only be done by the logged in user.
|
||||
operationId: updateUser
|
||||
parameters:
|
||||
- in: path
|
||||
name: username
|
||||
description: name that need to be deleted
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/User"
|
||||
description: Updated user object
|
||||
responses:
|
||||
"400":
|
||||
description: Invalid user supplied
|
||||
"404":
|
||||
description: User not found
|
||||
delete:
|
||||
tags:
|
||||
- user
|
||||
summary: Delete user
|
||||
description: This can only be done by the logged in user.
|
||||
operationId: deleteUser
|
||||
parameters:
|
||||
- in: path
|
||||
name: username
|
||||
description: The name that needs to be deleted
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
"400":
|
||||
description: Invalid username supplied
|
||||
"404":
|
||||
description: User not found
|
||||
externalDocs:
|
||||
description: Find out more about Swagger
|
||||
url: http://swagger.io
|
||||
servers:
|
||||
- url: http://petstore.swagger.io/v2
|
||||
components:
|
||||
responses:
|
||||
InvalidId:
|
||||
description: Invalid ID supplied
|
||||
requestBodies:
|
||||
UserArray:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/User"
|
||||
description: List of user object
|
||||
Pet:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Pet"
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Pet"
|
||||
description: Pet object that needs to be added to the store
|
||||
securitySchemes:
|
||||
api_key:
|
||||
type: apiKey
|
||||
name: api_key
|
||||
in: header
|
||||
description: This is another description
|
||||
petstore_auth:
|
||||
type: oauth2
|
||||
description: This is a standard oauth flow
|
||||
flows:
|
||||
implicit:
|
||||
authorizationUrl: http://petstore.swagger.io/api/oauth/dialog
|
||||
scopes:
|
||||
write_pets: modify pets in your account
|
||||
read_pets: read your pets
|
||||
schemas:
|
||||
User:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
username:
|
||||
type: string
|
||||
firstName:
|
||||
type: string
|
||||
lastName:
|
||||
type: string
|
||||
email:
|
||||
type: string
|
||||
password:
|
||||
type: string
|
||||
phone:
|
||||
type: string
|
||||
userStatus:
|
||||
type: integer
|
||||
format: int32
|
||||
description: User Status
|
||||
Category:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
name:
|
||||
type: string
|
||||
description: The name of the category
|
||||
minLength: 0
|
||||
maxLength: 255
|
||||
pattern: "[A-Za-zäöüÄÖÜß]{0,255}"
|
||||
default: DefaultCategory
|
||||
example: FoobarCategory
|
||||
Pet:
|
||||
type: object
|
||||
required:
|
||||
- name
|
||||
- photoUrls
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
category:
|
||||
$ref: "#/components/schemas/Category"
|
||||
name:
|
||||
type: string
|
||||
example: doggie
|
||||
photoUrls:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
tags:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Tag"
|
||||
status:
|
||||
type: string
|
||||
description: pet status in the store,
|
||||
enum:
|
||||
- Dead
|
||||
- Alive
|
||||
Tag:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
name:
|
||||
type: string
|
||||
Order:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
petId:
|
||||
type: integer
|
||||
format: int64
|
||||
quantity:
|
||||
type: integer
|
||||
format: int32
|
||||
minimum: 0
|
||||
maximum: 10000
|
||||
default: 0
|
||||
example: 10
|
||||
shipDate:
|
||||
type: string
|
||||
format: date-time
|
||||
status:
|
||||
type: string
|
||||
description: Order Status
|
||||
enum:
|
||||
- Ordered
|
||||
- Cancelled
|
||||
complete:
|
||||
type: boolean
|
||||
@@ -1,87 +0,0 @@
|
||||
import java.text.SimpleDateFormat
|
||||
|
||||
Date buildTimeAndDate = new Date()
|
||||
ext {
|
||||
buildDate = new SimpleDateFormat('yyyy-MM-dd').format(buildTimeAndDate)
|
||||
buildTime = new SimpleDateFormat('HH:mm:ss.SSSZ').format(buildTimeAndDate)
|
||||
licenseUrl = 'https://github.com/Swagger2Markup/swagger2markup/blob/master/LICENSE.txt'
|
||||
scmUrl = 'https://github.com/Swagger2Markup/swagger2markup.git'
|
||||
}
|
||||
|
||||
def projectArtifactId = 'swagger2markup'
|
||||
def projectUrl = 'https://github.com/Swagger2Markup/swagger2markup'
|
||||
def licenseUrl = 'https://github.com/Swagger2Markup/swagger2markup/blob/master/LICENSE.txt'
|
||||
def scmUrl = 'https://github.com/Swagger2Markup/swagger2markup.git'
|
||||
def issuesUrl = 'https://github.com/Swagger2Markup/swagger2markup/issues'
|
||||
|
||||
jar {
|
||||
manifest {
|
||||
attributes(
|
||||
'Built-By': 'Robert Winkler',
|
||||
'Created-By': System.properties['java.version'] + " (" + System.properties['java.vendor'] + " " + System.properties['java.vm.version'] + ")",
|
||||
'Build-Date': project.buildDate,
|
||||
'Build-Time': project.buildTime,
|
||||
'Specification-Title': projectArtifactId,
|
||||
'Specification-Version': project.version,
|
||||
'Implementation-Title': projectArtifactId,
|
||||
'Implementation-Version': project.version
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
task sourcesJar(type: Jar) {
|
||||
from sourceSets.main.allJava
|
||||
archiveClassifier = 'sources'
|
||||
}
|
||||
|
||||
task javadocJar(type: Jar) {
|
||||
from javadoc
|
||||
archiveClassifier = 'javadoc'
|
||||
}
|
||||
|
||||
artifacts {
|
||||
archives sourcesJar
|
||||
archives javadocJar
|
||||
}
|
||||
|
||||
publishing {
|
||||
publications {
|
||||
mavenJava(MavenPublication) {
|
||||
from components.java
|
||||
pom.withXml {
|
||||
def devs = ['RobWin': 'Robert Winkler',
|
||||
'austek': 'Ali Ustek']
|
||||
def root = asNode()
|
||||
|
||||
root.dependencies.'*'.findAll() {
|
||||
it.scope.text() == 'runtime' && project.configurations.compile.allDependencies.find { dep ->
|
||||
dep.name == it.artifactId.text()
|
||||
}
|
||||
}.each() {
|
||||
it.scope*.value = 'compile'
|
||||
}
|
||||
|
||||
root.appendNode('name', projectArtifactId)
|
||||
root.appendNode('packaging', 'jar')
|
||||
root.appendNode('url', projectUrl)
|
||||
root.appendNode('description', project.description)
|
||||
|
||||
def license = root.appendNode('licenses').appendNode('license')
|
||||
license.appendNode('name', 'Apache-2.0')
|
||||
license.appendNode('url', licenseUrl)
|
||||
license.appendNode('distribution', 'repo')
|
||||
|
||||
root.appendNode('scm').appendNode('url', scmUrl)
|
||||
|
||||
def developers = root.appendNode('developers')
|
||||
devs.each {
|
||||
def d = developers.appendNode('developer')
|
||||
d.appendNode('id', it.key)
|
||||
d.appendNode('name', it.value)
|
||||
}
|
||||
}
|
||||
artifact sourcesJar
|
||||
artifact javadocJar
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,10 +1 @@
|
||||
rootProject.name = 'swagger2markup'
|
||||
|
||||
include 'swagger2markup-asciidoc'
|
||||
include 'swagger2markup-bom'
|
||||
include 'swagger2markup-builder'
|
||||
include 'swagger2markup-documentation'
|
||||
include 'swagger2markup'
|
||||
include 'swagger2markup-core'
|
||||
include 'openapi2markup'
|
||||
|
||||
rootProject.name = 'swagger2markup'
|
||||
@@ -16,7 +16,7 @@ You can show the help:
|
||||
|
||||
[source, subs="attributes"]
|
||||
----
|
||||
java -jar swagger2markup-cli-{release-version}.jar help convert
|
||||
java -jar swagger2markup-cli-{project-version}.jar help convert
|
||||
----
|
||||
|
||||
Output:
|
||||
@@ -57,7 +57,7 @@ You can convert a Swagger file into a folder as follows:
|
||||
|
||||
[source, subs="attributes"]
|
||||
----
|
||||
java -jar swagger2markup-cli-{release-version}.jar convert -i /path/to/swagger_petstore.yaml -d /tmp/asiidoc
|
||||
java -jar swagger2markup-cli-1.0.0-SNAPSHOT.jar convert -i /path/to/swagger_petstore.yaml -d /tmp/asiidoc
|
||||
----
|
||||
|
||||
It generates the Markup documents into the `/tmp/asiidoc` folder.
|
||||
@@ -68,7 +68,7 @@ You can convert a local Swagger file into a file as follows:
|
||||
|
||||
[source, subs="attributes"]
|
||||
----
|
||||
java -jar swagger2markup-cli-{release-version}.jar convert -i /path/to/swagger_petstore.yaml -f /tmp/asiidoc/swagger
|
||||
java -jar swagger2markup-cli-1.0.0-SNAPSHOT.jar convert -i /path/to/swagger_petstore.yaml -f /tmp/asiidoc/swagger
|
||||
----
|
||||
|
||||
NOTE: The input file must not have a file extension
|
||||
@@ -81,7 +81,7 @@ You can convert a remote Swagger specification which must be accessible via HTTP
|
||||
|
||||
[source, subs="attributes"]
|
||||
----
|
||||
java -jar swagger2markup-cli-{release-version}.jar convert -i "http://petstore.swagger.io/v2/swagger.json" -d /tmp
|
||||
java -jar swagger2markup-cli-1.0.0-SNAPSHOT.jar convert -i "http://petstore.swagger.io/v2/swagger.json" -d /tmp
|
||||
----
|
||||
|
||||
=== Configuration
|
||||
@@ -98,6 +98,6 @@ Invoke the CLI as follows:
|
||||
|
||||
[source, subs="attributes"]
|
||||
----
|
||||
java -jar swagger2markup-cli-{release-version}.jar convert -i /path/to/swagger_petstore.yaml -o /tmp -c /path/to/config.properties
|
||||
java -jar swagger2markup-cli-1.0.0-SNAPSHOT.jar convert -i /path/to/swagger_petstore.yaml -o /tmp -c /path/to/config.properties
|
||||
----
|
||||
|
||||
@@ -22,7 +22,7 @@ To create a custom extension, you have to create a class (e.g. `io.myname.MyExte
|
||||
|
||||
[source,java,indent=0]
|
||||
----
|
||||
include::{coreProjectDir}/src/test/java/io/github/swagger2markup/builder/MyExtension.java[tags=MyExtension]
|
||||
include::../../test/java/io/github/swagger2markup/builder/MyExtension.java[tags=MyExtension]
|
||||
----
|
||||
1. You can retrieve extension properties from the config to configure the extension.
|
||||
2. You can retrieve a `MarkupDocBuilder` from the `Context`.
|
||||
@@ -47,7 +47,7 @@ To register your extension manually, you have to use the `Swagger2MarkupExtensio
|
||||
|
||||
[source,java,indent=0]
|
||||
----
|
||||
include::{coreProjectDir}/src/test/java/io/github/swagger2markup/DocumentationTest.java[tags=swagger2MarkupExtensionRegistryBuilder]
|
||||
include::../../test/java/io/github/swagger2markup/DocumentationTest.java[tags=swagger2MarkupExtensionRegistryBuilder]
|
||||
----
|
||||
1. Create a ``Swagger2MarkupExtensionRegistryBuilder`` using the default constructor
|
||||
2. Register your custom extension
|
||||
@@ -142,7 +142,7 @@ Example:
|
||||
|
||||
[source,java,indent=0]
|
||||
----
|
||||
include::{coreProjectDir}/src/test/java/io/github/swagger2markup/builder/MySwaggerModelExtension.java[tags=MySwaggerModelExtension]
|
||||
include::../../test/java/io/github/swagger2markup/builder/MySwaggerModelExtension.java[tags=MySwaggerModelExtension]
|
||||
----
|
||||
1. You can change any Swagger model property
|
||||
2. You could even remove elements from the Swagger model
|
||||
@@ -19,7 +19,7 @@ repositories {
|
||||
jCenter()
|
||||
}
|
||||
|
||||
compile "io.github.swagger2markup:swagger2markup:{release-version}"
|
||||
compile "io.github.swagger2markup:swagger2markup:{project-version}"
|
||||
----
|
||||
|
||||
==== Snapshot
|
||||
@@ -50,7 +50,7 @@ repositories {
|
||||
<dependency>
|
||||
<groupId>io.github.swagger2markup</groupId>
|
||||
<artifactId>swagger2markup</artifactId>
|
||||
<version>{release-version}</version>
|
||||
<version>{project-version}</version>
|
||||
</dependency>
|
||||
----
|
||||
|
||||
@@ -18,7 +18,7 @@ buildscript {
|
||||
}
|
||||
|
||||
dependencies {
|
||||
classpath 'io.github.swagger2markup:swagger2markup-gradle-plugin:{release-version}'
|
||||
classpath 'io.github.swagger2markup:swagger2markup-gradle-plugin:{project-version}'
|
||||
}
|
||||
}
|
||||
|
||||
|
Before Width: | Height: | Size: 130 KiB After Width: | Height: | Size: 130 KiB |
|
Before Width: | Height: | Size: 116 KiB After Width: | Height: | Size: 116 KiB |
|
Before Width: | Height: | Size: 133 KiB After Width: | Height: | Size: 133 KiB |
|
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 46 KiB |
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 38 KiB |
|
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
@@ -5,7 +5,7 @@ Robert Winkler
|
||||
:source-highlighter: coderay
|
||||
:numbered:
|
||||
:hardbreaks:
|
||||
:revnumber: {release-version}
|
||||
:revnumber: {project-version}
|
||||
:revdate: {localdate}
|
||||
:icons: font
|
||||
:pagenums:
|
||||
@@ -26,8 +26,6 @@ include::maven_plugin.adoc[]
|
||||
|
||||
include::command_line_interface.adoc[]
|
||||
|
||||
include::docker.adoc[]
|
||||
|
||||
include::demo.adoc[]
|
||||
|
||||
include::contributing.adoc[]
|
||||
@@ -6,7 +6,7 @@ NOTE: The Swagger Specification has been donated to to the https://openapis.org/
|
||||
|
||||
Swagger2Markup converts a Swagger JSON or YAML specification into either **AsciiDoc**, **GitHub Flavored Markdown** or *Atlassian Confluence Wiki* documents which can be combined with hand-written Markup documentation. The Swagger source file can be located locally or remotely via HTTP. Internally Swagger2Markup uses the __official__ https://github.com/swagger-api/swagger-parser[swagger-parser] and https://github.com/Swagger2Markup/markup-document-builder[markup-document-builder].
|
||||
|
||||
You can use Swagger2Markup to convert your contract-first Swagger YAML file into Markup. As an alternative, you can choose the code-first approach and use Swagger2Markup together with https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-JAX-RS-Project-Setup-1.5.X[Swagger JAX-RS], https://github.com/springfox/springfox[Springfox] or https://github.com/spring-projects/spring-restdocs[spring-restdocs]. If you are a Gradle or Maven user, you can also use the https://github.com/Swagger2Markup/swagger2markup-gradle-plugin[Swagger2Markup Gradle Plugin] or https://github.com/redowl/swagger2markup-maven-plugin[Swagger2markup Maven Plugin].
|
||||
You can use Swagger2Markup to convert your contract-first Swagger YAML file into Markup. As an alternative, you can choose the code-first approach and use Swagger2Markup together with https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-JAX-RS-Project-Setup-1.5.X[Swagger JAX-RS], https://github.com/springfox/springfox[Springfox] or https://github.com/spring-projects/spring-restdocs[spring-restdocs]. If you are are Gradle or Maven user, you can also use the https://github.com/Swagger2Markup/swagger2markup-gradle-plugin[Swagger2Markup Gradle Plugin] or https://github.com/redowl/swagger2markup-maven-plugin[Swagger2markup Maven Plugin].
|
||||
|
||||
NOTE: The project requires at least JDK 8.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
== License
|
||||
|
||||
Copyright 2017 Robert Winkler
|
||||
Copyright 2016 Robert Winkler
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
|
||||
|
||||
@@ -31,7 +31,7 @@ Add the following snippet to your Maven POM file:
|
||||
<plugin>
|
||||
<groupId>io.github.swagger2markup</groupId>
|
||||
<artifactId>swagger2markup-maven-plugin</artifactId>
|
||||
<version>{release-version}</version>
|
||||
<version>{project-version}</version>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
@@ -45,14 +45,14 @@ The plugin adds a new task goal `swagger2markup:convertSwagger2markup`. You can
|
||||
|
||||
You can customize the task by configuring a Map of <<Swagger2Markup properties>>.
|
||||
|
||||
[source,xml, subs="specialcharacters,attributes"]
|
||||
[source,xml]
|
||||
----
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>io.github.swagger2markup</groupId>
|
||||
<artifactId>swagger2markup-maven-plugin</artifactId>
|
||||
<version>{release-version}</version>
|
||||
<version>{project-version}</version>
|
||||
<configuration>
|
||||
<swaggerInput>${project.basedir}/src/docs/swagger/swagger_petstore.yaml</swaggerInput>
|
||||
<outputDir>${project.build.directory}/asciidoc</outputDir>
|
||||
@@ -7,14 +7,14 @@ Swagger2Markup converts a Swagger JSON or YAML specification into either **Ascii
|
||||
|
||||
==== Conversion of a local Swagger file
|
||||
|
||||
The entry point of the Swagger2Markup API is the ``Swagger2MarkupConverter`` class. This class provides static factory methods to create a `Swagger2MarkupConverter.Builder`.
|
||||
The entry point of the Swagger2Markup API is the ``Swagger2MarkupConverter`` class. This class provides static factory methods to create a `Swagger2MarkupConverter.Builder`.
|
||||
|
||||
[source,java,indent=0]
|
||||
----
|
||||
include::{coreProjectDir}/src/test/java/io/github/swagger2markup/DocumentationTest.java[tags=localSwaggerSpec]
|
||||
include::../../test/java/io/github/swagger2markup/DocumentationTest.java[tags=localSwaggerSpec]
|
||||
----
|
||||
|
||||
1. Create a ``Swagger2MarkupConverter.Builder`` by specifying the Path to the local file
|
||||
1. Create a ``Swagger2MarkupConverter.Builder`` by specifying the Path to the local file
|
||||
2. Build an instance of the ``Swagger2MarkupConverter``
|
||||
3. Invoke ``toFolder`` by specifying the output directory
|
||||
|
||||
@@ -26,7 +26,7 @@ You can convert a remote Swagger specification which must be accessible via HTTP
|
||||
|
||||
[source,java,indent=0]
|
||||
----
|
||||
include::{coreProjectDir}/src/test/java/io/github/swagger2markup/DocumentationTest.java[tags=remoteSwaggerSpec]
|
||||
include::../../test/java/io/github/swagger2markup/DocumentationTest.java[tags=remoteSwaggerSpec]
|
||||
----
|
||||
|
||||
1. Create a ``Swagger2MarkupConverter.Builder`` by specifying the URL to the remote file
|
||||
@@ -40,7 +40,7 @@ You can convert the Swagger specification into a file.
|
||||
|
||||
[source,java,indent=0]
|
||||
----
|
||||
include::{coreProjectDir}/src/test/java/io/github/swagger2markup/DocumentationTest.java[tags=convertIntoOneFile]
|
||||
include::../../test/java/io/github/swagger2markup/DocumentationTest.java[tags=convertIntoOneFile]
|
||||
----
|
||||
|
||||
==== Conversion to a String
|
||||
@@ -50,7 +50,7 @@ You can convert the Swagger specification to a String.
|
||||
|
||||
[source,java,indent=0]
|
||||
----
|
||||
include::{coreProjectDir}/src/test/java/io/github/swagger2markup/DocumentationTest.java[tags=convertIntoString]
|
||||
include::../../test/java/io/github/swagger2markup/DocumentationTest.java[tags=convertIntoString]
|
||||
----
|
||||
|
||||
=== Configuration
|
||||
@@ -69,7 +69,7 @@ You can configure the Swagger2MarkupConverter by using the `Swagger2MarkupConfig
|
||||
|
||||
[source,java,indent=0]
|
||||
----
|
||||
include::{coreProjectDir}/src/test/java/io/github/swagger2markup/DocumentationTest.java[tags=swagger2MarkupConfigBuilder]
|
||||
include::../../test/java/io/github/swagger2markup/DocumentationTest.java[tags=swagger2MarkupConfigBuilder]
|
||||
----
|
||||
|
||||
1. Create a `Swagger2MarkupConfigBuilder` using the default constructor.
|
||||
@@ -85,7 +85,7 @@ You can also create a `Swagger2MarkupConfig` from a Properties file, a `Map` or
|
||||
|
||||
[source,java,indent=0]
|
||||
----
|
||||
include::{coreProjectDir}/src/test/java/io/github/swagger2markup/DocumentationTest.java[tags=swagger2MarkupConfigFromProperties]
|
||||
include::../../test/java/io/github/swagger2markup/DocumentationTest.java[tags=swagger2MarkupConfigFromProperties]
|
||||
----
|
||||
1. Load a `Properties` file from the classpath or local filesystem.
|
||||
2. Create a `Swagger2MarkupConfigBuilder` using the proper constructor.
|
||||
@@ -94,7 +94,7 @@ include::{coreProjectDir}/src/test/java/io/github/swagger2markup/DocumentationTe
|
||||
|
||||
[source,java,indent=0]
|
||||
----
|
||||
include::{coreProjectDir}/src/test/java/io/github/swagger2markup/DocumentationTest.java[tags=swagger2MarkupConfigFromMap]
|
||||
include::../../test/java/io/github/swagger2markup/DocumentationTest.java[tags=swagger2MarkupConfigFromMap]
|
||||
----
|
||||
|
||||
1. Create a `Map` and configure the `Swagger2MarkupProperties`.
|
||||
@@ -113,7 +113,7 @@ Configuration parameters may be loaded from the following sources using Apache C
|
||||
|
||||
[source,java,indent=0]
|
||||
----
|
||||
include::{coreProjectDir}/src/test/java/io/github/swagger2markup/DocumentationTest.java[tags=swagger2MarkupConfigFromCommonsConfiguration]
|
||||
include::../../test/java/io/github/swagger2markup/DocumentationTest.java[tags=swagger2MarkupConfigFromCommonsConfiguration]
|
||||
----
|
||||
|
||||
1. Create an Apache Commons `Configuration` object using the proper ConfigurationBuilder.
|
||||
@@ -136,14 +136,12 @@ The following tables list all available properties of Swagger2Markup:
|
||||
|Name | Description | Possible Values | Default
|
||||
|swagger2markup.markupLanguage| Specifies the markup language which should be used to generate the files. | ASCIIDOC, MARKDOWN, CONFLUENCE_MARKUP | ASCIIDOC
|
||||
|swagger2markup.swaggerMarkupLanguage| Specifies the markup language used in Swagger descriptions. | ASCIIDOC, MARKDOWN, CONFLUENCE_MARKUP | MARKDOWN
|
||||
|swagger2markup.pathsGroupedBy| Specifies how the paths should be grouped | AS_IS, TAGS, REGEX | AS_IS
|
||||
|swagger2markup.pathsGroupedBy| Specifies how the paths should be grouped | AS_IS, TAGS | AS_IS
|
||||
|swagger2markup.outputLanguage| Specifies the language of the labels | EN, DE, FR, RU | EN
|
||||
|swagger2markup.lineSeparator| Specifies the line separator which should be used | UNIX, WINDOWS, MAC | <System-dependent>
|
||||
|swagger2markup.generatedExamplesEnabled| Specifies if HTTP request and response examples should be generated | true, false | false
|
||||
|swagger2markup.flatBodyEnabled| Optionally isolate the body parameter, if any, from other parameters | true, false | false
|
||||
|swagger2markup.pathSecuritySectionEnabled| Optionally disable the security section for path sections | true, false | true
|
||||
|swagger2markup.anchorPrefix| Optionally prefix all anchors for uniqueness if you want to include generated documents into a global documentation | Any String |
|
||||
|swagger2markup.basePathPrefixEnabled| Prepend the basePath to all paths | true, false | false
|
||||
|swagger2markup.headerRegex | Regular expression to use when grouping by RegEx | Any valid RegEx pattern with at least one capture group |
|
||||
|swagger2markup.anchorPrefix| Optionally prefix all anchors for uniqueness if you want to include generated documents into a global documentation | Any String |
|
||||
|===
|
||||
|
||||
[options="header"]
|
||||
@@ -183,7 +181,7 @@ The following tables list all available properties of Swagger2Markup:
|
||||
|===
|
||||
|Name | Description | Possible Values | Default
|
||||
|swagger2markup.interDocumentCrossReferencesEnabled| Enable use of inter-document cross-references when needed | true, false | false
|
||||
|swagger2markup.interDocumentCrossReferencesPrefix| Specifies a prefix for all inter-document cross-references for advanced usage | Any String |
|
||||
|swagger2markup.interDocumentCrossReferencesPrefix| Specifies a prefix for all inter-document cross-references for advanced usage | Any String |
|
||||
|===
|
||||
|
||||
[options="header"]
|
||||
@@ -193,66 +191,6 @@ The following tables list all available properties of Swagger2Markup:
|
||||
|swagger2markup.inlineSchemaEnabled| Enable inline object schema support | true, false | true
|
||||
|===
|
||||
|
||||
[options="header"]
|
||||
.Properties which configure page breaking
|
||||
|===
|
||||
|Name | Description | Possible Values | Default
|
||||
|swagger2markup.pageBreakLocations | Specifies where page breaks should be inserted. | BEFORE_OPERATION, BEFORE_OPERATION_DESCRIPTION, BEFORE_OPERATION_PARAMETERS, BEFORE_OPERATION_RESPONSES, BEFORE_OPERATION_CONSUMES, BEFORE_OPERATION_PRODUCES, BEFORE_OPERATION_EXAMPLE_REQUEST, BEFORE_OPERATION_EXAMPLE_RESPONSE, BEFORE_DEFINITION, AFTER_OPERATION, AFTER_OPERATION_DESCRIPTION, AFTER_OPERATION_PARAMETERS, AFTER_OPERATION_RESPONSES, AFTER_OPERATION_CONSUMES, AFTER_OPERATION_PRODUCES, AFTER_OPERATION_EXAMPLE_REQUEST, AFTER_OPERATION_EXAMPLE_RESPONSE, AFTER_DEFINITION | empty
|
||||
|===
|
||||
|
||||
|
||||
[options="header"]
|
||||
.Properties which configure examples generation
|
||||
|===
|
||||
|Name |Description |Possible Values |Default
|
||||
|
||||
|swagger2markup.generatedExamplesEnabled
|
||||
| Specifies if HTTP request and response examples should be generated
|
||||
| true, false
|
||||
| false
|
||||
|
||||
|swagger2markup.requestExamplesFormat
|
||||
| Specifies if `Request path` contents in `Example HTTP request` section should contain popular example utility
|
||||
invocation, e.g. `curl`
|
||||
a|
|
||||
* `basic` — example will have only endpoint and query params
|
||||
* `curl` — example with `curl` utility
|
||||
* `invoke-webrequest` — example with `Invoke-WebRequest` command of `powershell`
|
||||
| basic
|
||||
|
||||
|swagger2markup.requestExamplesSourceFormat
|
||||
|`Request path` source block code style format
|
||||
| `default` or any suppordet by asciidoc
|
||||
| none for `basic`, `bash` for `curl` and `powershell` for `WebRequest`
|
||||
|
||||
|swagger2markup.requestExamplesIncludeAllQueryParams
|
||||
|Specifies if `Request path` should contain required and optional params (if true) or only required (if false)
|
||||
|true, false
|
||||
|false
|
||||
|
||||
|swagger2markup.requestExamplesHost
|
||||
|Should we hide, inherit or override hostname (e.g. with google.com) from yml file
|
||||
|`hide`, `inherit` or string with hostname to be used in request example
|
||||
| hide
|
||||
|
||||
|swagger2markup.requestExamplesSchema
|
||||
|Should we hide, inherit or override schema (http, https name it) from yml file
|
||||
|`hide`, `inherit` or string with schema name to be used in request example
|
||||
| hide
|
||||
|
||||
|swagger2markup.requestExamplesHideBasePath
|
||||
|Should we hide or show base path in example request endpoint address
|
||||
|true, false
|
||||
|true
|
||||
|
||||
|swagger2markup.requestExamplesQueryArrayStyle
|
||||
|How we should output array query params
|
||||
|`single` — single time (similar to basic types), `commaSeparated` — single time with multiple comma separated values, `multiple` times with same param name and different values, `multiple[]` times with array brackets as param name suffix.
|
||||
|single
|
||||
|
||||
|
||||
|===
|
||||
|
||||
=== Logging
|
||||
|
||||
Swagger2Markup uses http://www.slf4j.org/[SLF4J] for all internal logging, but leaves the underlying log implementation open. To change the log level, you have the set the log level of the `io.github.swagger2markup` package.
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
* Copyright 2016 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@@ -15,11 +15,7 @@
|
||||
*/
|
||||
package io.github.swagger2markup;
|
||||
|
||||
/**
|
||||
* GroupBy enum for ordering
|
||||
*/
|
||||
public enum GroupBy {
|
||||
AS_IS,
|
||||
TAGS,
|
||||
REGEX
|
||||
TAGS
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
* Copyright 2016 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@@ -22,16 +22,11 @@ import java.util.Locale;
|
||||
* @author Maksim Myshkin
|
||||
*/
|
||||
public enum Language {
|
||||
EN(Locale.ENGLISH),
|
||||
EN(new Locale("en")),
|
||||
RU(new Locale("ru")),
|
||||
FR(Locale.FRENCH),
|
||||
DE(Locale.GERMAN),
|
||||
TR(new Locale("tr")),
|
||||
ZH(Locale.CHINESE),
|
||||
ES(new Locale("es")),
|
||||
BR(new Locale("pt", "BR")),
|
||||
JA(Locale.JAPANESE),
|
||||
PL(new Locale("pl"));
|
||||
FR(new Locale("fr")),
|
||||
DE(new Locale("de")),
|
||||
TR(new Locale("tr"));
|
||||
|
||||
private final Locale lang;
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
* Copyright 2016 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
206
src/main/java/io/github/swagger2markup/Swagger2MarkupConfig.java
Normal file
@@ -0,0 +1,206 @@
|
||||
/*
|
||||
* Copyright 2016 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup;
|
||||
|
||||
import io.github.swagger2markup.markup.builder.LineSeparator;
|
||||
import io.github.swagger2markup.markup.builder.MarkupLanguage;
|
||||
import io.github.swagger2markup.model.PathOperation;
|
||||
import io.swagger.models.parameters.Parameter;
|
||||
|
||||
import java.util.Comparator;
|
||||
|
||||
/**
|
||||
* Swagger2Markup configuration interface.
|
||||
*/
|
||||
public interface Swagger2MarkupConfig {
|
||||
|
||||
/**
|
||||
* Specifies the markup language which should be used to generate the files.
|
||||
*/
|
||||
MarkupLanguage getMarkupLanguage();
|
||||
|
||||
/**
|
||||
* Specifies the markup language used in Swagger descriptions.<br>
|
||||
* By default, {@link io.github.swagger2markup.markup.builder.MarkupLanguage#MARKDOWN} is assumed.
|
||||
*/
|
||||
MarkupLanguage getSwaggerMarkupLanguage();
|
||||
|
||||
/**
|
||||
* Include generated examples into the documents.
|
||||
*/
|
||||
boolean isGeneratedExamplesEnabled();
|
||||
|
||||
/**
|
||||
* In addition to the Definitions file, also create separate definition files for each model definition.
|
||||
*/
|
||||
boolean isSeparatedDefinitionsEnabled();
|
||||
|
||||
/**
|
||||
* In addition to the Paths file, also create separate operation files for each operation.
|
||||
*/
|
||||
boolean isSeparatedOperationsEnabled();
|
||||
|
||||
/**
|
||||
* Specifies if the operations should be grouped by tags or stay as-is.
|
||||
*/
|
||||
GroupBy getPathsGroupedBy();
|
||||
|
||||
/**
|
||||
* Specifies labels language of output files.
|
||||
*/
|
||||
Language getOutputLanguage();
|
||||
|
||||
/**
|
||||
* Specifies if inline schemas are detailed
|
||||
*/
|
||||
boolean isInlineSchemaEnabled();
|
||||
|
||||
/**
|
||||
* Specifies tag ordering.
|
||||
*/
|
||||
OrderBy getTagOrderBy();
|
||||
|
||||
/**
|
||||
* Specifies a custom comparator function to order tags.
|
||||
*/
|
||||
Comparator<String> getTagOrdering();
|
||||
|
||||
/**
|
||||
* Specifies operation ordering.
|
||||
*/
|
||||
OrderBy getOperationOrderBy();
|
||||
|
||||
/**
|
||||
* Specifies a custom comparator function to order operations.
|
||||
*/
|
||||
Comparator<PathOperation> getOperationOrdering();
|
||||
|
||||
/**
|
||||
* Specifies definition ordering.
|
||||
*/
|
||||
OrderBy getDefinitionOrderBy();
|
||||
|
||||
/**
|
||||
* Specifies a custom comparator function to order definitions.
|
||||
*/
|
||||
Comparator<String> getDefinitionOrdering();
|
||||
|
||||
/**
|
||||
* Specifies parameter ordering.
|
||||
*/
|
||||
OrderBy getParameterOrderBy();
|
||||
|
||||
/**
|
||||
* Specifies a custom comparator function to order parameters.
|
||||
*/
|
||||
Comparator<Parameter> getParameterOrdering();
|
||||
|
||||
/**
|
||||
* Specifies property ordering.
|
||||
*/
|
||||
OrderBy getPropertyOrderBy();
|
||||
|
||||
/**
|
||||
* Specifies a custom comparator function to order properties.
|
||||
*/
|
||||
Comparator<String> getPropertyOrdering();
|
||||
|
||||
/**
|
||||
* Specifies response ordering.
|
||||
*/
|
||||
OrderBy getResponseOrderBy();
|
||||
|
||||
/**
|
||||
* Specifies a custom comparator function to order responses.
|
||||
*/
|
||||
Comparator<String> getResponseOrdering();
|
||||
|
||||
/**
|
||||
* Enable use of inter-document cross-references when needed.
|
||||
*/
|
||||
boolean isInterDocumentCrossReferencesEnabled();
|
||||
|
||||
/**
|
||||
* Inter-document cross-references optional prefix.
|
||||
*/
|
||||
String getInterDocumentCrossReferencesPrefix();
|
||||
|
||||
/**
|
||||
* Optionally isolate the body parameter, if any, from other parameters.
|
||||
*/
|
||||
boolean isFlatBodyEnabled();
|
||||
|
||||
/**
|
||||
* Optionally prefix all anchors for uniqueness.
|
||||
*/
|
||||
String getAnchorPrefix();
|
||||
|
||||
/**
|
||||
* Overview document name (without extension).
|
||||
*
|
||||
* @return the overview document name (without extension)
|
||||
*/
|
||||
String getOverviewDocument();
|
||||
|
||||
/**
|
||||
* Paths document name (without extension).
|
||||
*
|
||||
* @return the paths document name (without extension)
|
||||
*/
|
||||
String getPathsDocument();
|
||||
|
||||
/**
|
||||
* Definitions document name (without extension).
|
||||
*
|
||||
* @return the definitions document name (without extension)
|
||||
*/
|
||||
String getDefinitionsDocument();
|
||||
|
||||
/**
|
||||
* Security document name (without extension).
|
||||
*
|
||||
* @return the security document name (without extension)
|
||||
*/
|
||||
String getSecurityDocument();
|
||||
|
||||
/**
|
||||
* Separated operations sub-folder name.
|
||||
*
|
||||
* @return the operations sub-folder name
|
||||
*/
|
||||
String getSeparatedOperationsFolder();
|
||||
|
||||
/**
|
||||
* Separated definitions sub-folder name.
|
||||
*
|
||||
* @return the definitions sub-folder name
|
||||
*/
|
||||
String getSeparatedDefinitionsFolder();
|
||||
|
||||
/**
|
||||
* Specifies the line separator which should be used.
|
||||
*
|
||||
* @return the line separator
|
||||
*/
|
||||
LineSeparator getLineSeparator();
|
||||
|
||||
/**
|
||||
* Returns properties for extensions.
|
||||
*
|
||||
* @return the extension properties
|
||||
*/
|
||||
Swagger2MarkupProperties getExtensionsProperties();
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
* Copyright 2016 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@@ -17,15 +17,11 @@ package io.github.swagger2markup;
|
||||
|
||||
import io.github.swagger2markup.builder.Swagger2MarkupConfigBuilder;
|
||||
import io.github.swagger2markup.builder.Swagger2MarkupExtensionRegistryBuilder;
|
||||
import io.github.swagger2markup.internal.document.DefinitionsDocument;
|
||||
import io.github.swagger2markup.internal.document.OverviewDocument;
|
||||
import io.github.swagger2markup.internal.document.PathsDocument;
|
||||
import io.github.swagger2markup.internal.document.SecurityDocument;
|
||||
import io.github.swagger2markup.markup.builder.LineSeparator;
|
||||
import io.github.swagger2markup.markup.builder.MarkupDocBuilder;
|
||||
import io.github.swagger2markup.markup.builder.MarkupDocBuilders;
|
||||
import io.github.swagger2markup.markup.builder.MarkupLanguage;
|
||||
import io.github.swagger2markup.spi.Swagger2MarkupExtensionRegistry;
|
||||
import io.github.swagger2markup.internal.document.builder.DefinitionsDocumentBuilder;
|
||||
import io.github.swagger2markup.internal.document.builder.OverviewDocumentBuilder;
|
||||
import io.github.swagger2markup.internal.document.builder.PathsDocumentBuilder;
|
||||
import io.github.swagger2markup.internal.document.builder.SecurityDocumentBuilder;
|
||||
import io.github.swagger2markup.spi.*;
|
||||
import io.github.swagger2markup.utils.URIUtils;
|
||||
import io.swagger.models.Swagger;
|
||||
import io.swagger.parser.SwaggerParser;
|
||||
@@ -49,20 +45,24 @@ import java.nio.file.StandardOpenOption;
|
||||
/**
|
||||
* @author Robert Winkler
|
||||
*/
|
||||
public class Swagger2MarkupConverter extends AbstractSchema2MarkupConverter<Swagger> {
|
||||
private final OverviewDocument overviewDocument;
|
||||
private final PathsDocument pathsDocument;
|
||||
private final DefinitionsDocument definitionsDocument;
|
||||
private final SecurityDocument securityDocument;
|
||||
private final SwaggerContext swaggerContext;
|
||||
public class Swagger2MarkupConverter {
|
||||
|
||||
public Swagger2MarkupConverter(SwaggerContext swaggerContext) {
|
||||
super(swaggerContext);
|
||||
this.swaggerContext = swaggerContext;
|
||||
this.overviewDocument = new OverviewDocument(swaggerContext);
|
||||
this.pathsDocument = new PathsDocument(swaggerContext);
|
||||
this.definitionsDocument = new DefinitionsDocument(swaggerContext);
|
||||
this.securityDocument = new SecurityDocument(swaggerContext);
|
||||
private Context context;
|
||||
|
||||
private Swagger2MarkupExtensionRegistry extensionRegistry;
|
||||
|
||||
public Swagger2MarkupConverter(Context globalContext, Swagger2MarkupExtensionRegistry extensionRegistry) {
|
||||
this.context = globalContext;
|
||||
this.extensionRegistry = extensionRegistry;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the global Context
|
||||
*
|
||||
* @return the global Context
|
||||
*/
|
||||
Context getContext(){
|
||||
return context;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -74,15 +74,17 @@ public class Swagger2MarkupConverter extends AbstractSchema2MarkupConverter<Swag
|
||||
public static Builder from(URI swaggerUri) {
|
||||
Validate.notNull(swaggerUri, "swaggerUri must not be null");
|
||||
String scheme = swaggerUri.getScheme();
|
||||
if (scheme != null && swaggerUri.getScheme().startsWith("http")) {
|
||||
if(scheme != null && swaggerUri.getScheme().startsWith("http")){
|
||||
try {
|
||||
return from(swaggerUri.toURL());
|
||||
} catch (MalformedURLException e) {
|
||||
}
|
||||
catch (MalformedURLException e) {
|
||||
throw new RuntimeException("Failed to convert URI to URL", e);
|
||||
}
|
||||
} else if (scheme != null && swaggerUri.getScheme().startsWith("file")) {
|
||||
} else if(scheme != null && swaggerUri.getScheme().startsWith("file")){
|
||||
return from(Paths.get(swaggerUri));
|
||||
} else {
|
||||
}
|
||||
else {
|
||||
return from(URIUtils.convertUriWithoutSchemeToFileScheme(swaggerUri));
|
||||
}
|
||||
}
|
||||
@@ -93,7 +95,7 @@ public class Swagger2MarkupConverter extends AbstractSchema2MarkupConverter<Swag
|
||||
* @param swaggerURL the remote URL
|
||||
* @return a Swagger2MarkupConverter
|
||||
*/
|
||||
public static Builder from(URL swaggerURL) {
|
||||
public static Builder from(URL swaggerURL){
|
||||
Validate.notNull(swaggerURL, "swaggerURL must not be null");
|
||||
return new Builder(swaggerURL);
|
||||
}
|
||||
@@ -106,11 +108,11 @@ public class Swagger2MarkupConverter extends AbstractSchema2MarkupConverter<Swag
|
||||
*/
|
||||
public static Builder from(Path swaggerPath) {
|
||||
Validate.notNull(swaggerPath, "swaggerPath must not be null");
|
||||
if (Files.notExists(swaggerPath)) {
|
||||
if(Files.notExists(swaggerPath)){
|
||||
throw new IllegalArgumentException(String.format("swaggerPath does not exist: %s", swaggerPath));
|
||||
}
|
||||
try {
|
||||
if (Files.isHidden(swaggerPath)) {
|
||||
if(Files.isHidden(swaggerPath)){
|
||||
throw new IllegalArgumentException("swaggerPath must not be a hidden file");
|
||||
}
|
||||
} catch (IOException e) {
|
||||
@@ -161,57 +163,18 @@ public class Swagger2MarkupConverter extends AbstractSchema2MarkupConverter<Swag
|
||||
return new Builder(swagger);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the global Context
|
||||
*
|
||||
* @return the global Context
|
||||
*/
|
||||
public SwaggerContext getContext() {
|
||||
return swaggerContext;
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts the Swagger specification into the given {@code outputDirectory}.
|
||||
*
|
||||
* @param outputDirectory the output directory path
|
||||
*/
|
||||
public void toFolder(Path outputDirectory) {
|
||||
public void toFolder(Path outputDirectory){
|
||||
Validate.notNull(outputDirectory, "outputDirectory must not be null");
|
||||
|
||||
swaggerContext.setOutputPath(outputDirectory);
|
||||
|
||||
applyOverviewDocument()
|
||||
.writeToFile(outputDirectory.resolve(swaggerContext.config.getOverviewDocument()), StandardCharsets.UTF_8);
|
||||
applyPathsDocument()
|
||||
.writeToFile(outputDirectory.resolve(swaggerContext.config.getPathsDocument()), StandardCharsets.UTF_8);
|
||||
applyDefinitionsDocument()
|
||||
.writeToFile(outputDirectory.resolve(swaggerContext.config.getDefinitionsDocument()), StandardCharsets.UTF_8);
|
||||
applySecurityDocument()
|
||||
.writeToFile(outputDirectory.resolve(swaggerContext.config.getSecurityDocument()), StandardCharsets.UTF_8);
|
||||
}
|
||||
|
||||
private MarkupDocBuilder applyOverviewDocument() {
|
||||
return overviewDocument.apply(
|
||||
swaggerContext.createMarkupDocBuilder(),
|
||||
OverviewDocument.parameters(swaggerContext.getSchema()));
|
||||
}
|
||||
|
||||
private MarkupDocBuilder applyPathsDocument() {
|
||||
return pathsDocument.apply(
|
||||
swaggerContext.createMarkupDocBuilder(),
|
||||
PathsDocument.parameters(swaggerContext.getSchema().getPaths()));
|
||||
}
|
||||
|
||||
private MarkupDocBuilder applyDefinitionsDocument() {
|
||||
return definitionsDocument.apply(
|
||||
swaggerContext.createMarkupDocBuilder(),
|
||||
DefinitionsDocument.parameters(swaggerContext.getSchema().getDefinitions()));
|
||||
}
|
||||
|
||||
private MarkupDocBuilder applySecurityDocument() {
|
||||
return securityDocument.apply(
|
||||
swaggerContext.createMarkupDocBuilder(),
|
||||
SecurityDocument.parameters(swaggerContext.getSchema().getSecurityDefinitions()));
|
||||
|
||||
new OverviewDocumentBuilder(context, extensionRegistry, outputDirectory).build().writeToFile(outputDirectory.resolve(context.config.getOverviewDocument()), StandardCharsets.UTF_8);
|
||||
new PathsDocumentBuilder(context, extensionRegistry, outputDirectory).build().writeToFile(outputDirectory.resolve(context.config.getPathsDocument()), StandardCharsets.UTF_8);
|
||||
new DefinitionsDocumentBuilder(context, extensionRegistry, outputDirectory).build().writeToFile(outputDirectory.resolve(context.config.getDefinitionsDocument()), StandardCharsets.UTF_8);
|
||||
new SecurityDocumentBuilder(context, extensionRegistry, outputDirectory).build().writeToFile(outputDirectory.resolve(context.config.getSecurityDocument()), StandardCharsets.UTF_8);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -239,10 +202,10 @@ public class Swagger2MarkupConverter extends AbstractSchema2MarkupConverter<Swag
|
||||
public void toFile(Path outputFile) {
|
||||
Validate.notNull(outputFile, "outputFile must not be null");
|
||||
|
||||
applyOverviewDocument().writeToFile(outputFile, StandardCharsets.UTF_8);
|
||||
applyPathsDocument().writeToFile(outputFile, StandardCharsets.UTF_8, StandardOpenOption.APPEND);
|
||||
applyDefinitionsDocument().writeToFile(outputFile, StandardCharsets.UTF_8, StandardOpenOption.APPEND);
|
||||
applySecurityDocument().writeToFile(outputFile, StandardCharsets.UTF_8, StandardOpenOption.APPEND);
|
||||
new OverviewDocumentBuilder(context,extensionRegistry, null).build().writeToFile(outputFile, StandardCharsets.UTF_8);
|
||||
new PathsDocumentBuilder(context, extensionRegistry, null).build().writeToFile(outputFile, StandardCharsets.UTF_8, StandardOpenOption.APPEND);
|
||||
new DefinitionsDocumentBuilder(context, extensionRegistry, null).build().writeToFile(outputFile, StandardCharsets.UTF_8, StandardOpenOption.APPEND);
|
||||
new SecurityDocumentBuilder(context, extensionRegistry, null).build().writeToFile(outputFile, StandardCharsets.UTF_8, StandardOpenOption.APPEND);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -250,13 +213,13 @@ public class Swagger2MarkupConverter extends AbstractSchema2MarkupConverter<Swag
|
||||
*
|
||||
* @param outputFile the output file
|
||||
*/
|
||||
public void toFileWithoutExtension(Path outputFile) {
|
||||
public void toFileWithoutExtension(Path outputFile){
|
||||
Validate.notNull(outputFile, "outputFile must not be null");
|
||||
|
||||
applyOverviewDocument().writeToFileWithoutExtension(outputFile, StandardCharsets.UTF_8);
|
||||
applyPathsDocument().writeToFileWithoutExtension(outputFile, StandardCharsets.UTF_8, StandardOpenOption.APPEND);
|
||||
applyDefinitionsDocument().writeToFileWithoutExtension(outputFile, StandardCharsets.UTF_8, StandardOpenOption.APPEND);
|
||||
applySecurityDocument().writeToFileWithoutExtension(outputFile, StandardCharsets.UTF_8, StandardOpenOption.APPEND);
|
||||
new OverviewDocumentBuilder(context, extensionRegistry, null).build().writeToFileWithoutExtension(outputFile, StandardCharsets.UTF_8);
|
||||
new PathsDocumentBuilder(context, extensionRegistry, null).build().writeToFileWithoutExtension(outputFile, StandardCharsets.UTF_8, StandardOpenOption.APPEND);
|
||||
new DefinitionsDocumentBuilder(context, extensionRegistry, null).build().writeToFileWithoutExtension(outputFile, StandardCharsets.UTF_8, StandardOpenOption.APPEND);
|
||||
new SecurityDocumentBuilder(context, extensionRegistry, null).build().writeToFileWithoutExtension(outputFile, StandardCharsets.UTF_8, StandardOpenOption.APPEND);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -267,10 +230,10 @@ public class Swagger2MarkupConverter extends AbstractSchema2MarkupConverter<Swag
|
||||
public String toString() {
|
||||
|
||||
StringBuilder sb = new StringBuilder();
|
||||
sb.append(applyOverviewDocument().toString());
|
||||
sb.append(applyPathsDocument().toString());
|
||||
sb.append(applyDefinitionsDocument().toString());
|
||||
sb.append(applySecurityDocument().toString());
|
||||
sb.append(new OverviewDocumentBuilder(context,extensionRegistry, null).build().toString());
|
||||
sb.append(new PathsDocumentBuilder(context, extensionRegistry, null).build().toString());
|
||||
sb.append(new DefinitionsDocumentBuilder(context, extensionRegistry, null).build().toString());
|
||||
sb.append(new SecurityDocumentBuilder(context, extensionRegistry, null).build().toString());
|
||||
return sb.toString();
|
||||
}
|
||||
|
||||
@@ -320,7 +283,7 @@ public class Swagger2MarkupConverter extends AbstractSchema2MarkupConverter<Swag
|
||||
* @param swaggerLocation the location of the Swagger source
|
||||
* @return the Swagger model
|
||||
*/
|
||||
private Swagger readSwagger(String swaggerLocation) {
|
||||
private Swagger readSwagger(String swaggerLocation){
|
||||
Swagger swagger = new SwaggerParser().read(swaggerLocation);
|
||||
if (swagger == null) {
|
||||
throw new IllegalArgumentException("Failed to read the Swagger source");
|
||||
@@ -346,62 +309,61 @@ public class Swagger2MarkupConverter extends AbstractSchema2MarkupConverter<Swag
|
||||
|
||||
if (extensionRegistry == null)
|
||||
extensionRegistry = new Swagger2MarkupExtensionRegistryBuilder().build();
|
||||
SwaggerLabels swaggerLabels = new SwaggerLabels(config);
|
||||
SwaggerContext context = new SwaggerContext(config, extensionRegistry, swagger, swaggerLocation, swaggerLabels);
|
||||
|
||||
Context context = new Context(config, swagger, swaggerLocation);
|
||||
|
||||
initExtensions(context);
|
||||
|
||||
applySwaggerExtensions(context);
|
||||
|
||||
return new Swagger2MarkupConverter(context);
|
||||
return new Swagger2MarkupConverter(context, extensionRegistry);
|
||||
}
|
||||
|
||||
private void initExtensions(SwaggerContext context) {
|
||||
extensionRegistry.getSwaggerModelExtensions().forEach(extension -> extension.setGlobalContext(context));
|
||||
extensionRegistry.getOverviewDocumentExtensions().forEach(extension -> extension.setGlobalContext(context));
|
||||
extensionRegistry.getDefinitionsDocumentExtensions().forEach(extension -> extension.setGlobalContext(context));
|
||||
extensionRegistry.getPathsDocumentExtensions().forEach(extension -> extension.setGlobalContext(context));
|
||||
extensionRegistry.getSecurityDocumentExtensions().forEach(extension -> extension.setGlobalContext(context));
|
||||
private void initExtensions(Context context) {
|
||||
for (SwaggerModelExtension extension : extensionRegistry.getSwaggerModelExtensions())
|
||||
extension.setGlobalContext(context);
|
||||
|
||||
for (OverviewDocumentExtension extension : extensionRegistry.getOverviewDocumentExtensions())
|
||||
extension.setGlobalContext(context);
|
||||
|
||||
for (DefinitionsDocumentExtension extension : extensionRegistry.getDefinitionsDocumentExtensions())
|
||||
extension.setGlobalContext(context);
|
||||
|
||||
for (PathsDocumentExtension extension : extensionRegistry.getPathsDocumentExtensions())
|
||||
extension.setGlobalContext(context);
|
||||
|
||||
for (SecurityDocumentExtension extension : extensionRegistry.getSecurityDocumentExtensions())
|
||||
extension.setGlobalContext(context);
|
||||
}
|
||||
|
||||
private void applySwaggerExtensions(SwaggerContext context) {
|
||||
extensionRegistry.getSwaggerModelExtensions().forEach(extension -> extension.apply(context.getSchema()));
|
||||
private void applySwaggerExtensions(Context context) {
|
||||
for (SwaggerModelExtension swaggerModelExtension : extensionRegistry.getSwaggerModelExtensions()) {
|
||||
swaggerModelExtension.apply(context.getSwagger());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public static class SwaggerContext extends Context<Swagger> {
|
||||
public static class Context {
|
||||
private Swagger2MarkupConfig config;
|
||||
private Swagger2MarkupExtensionRegistry extensionRegistry;
|
||||
private Swagger swagger;
|
||||
private URI swaggerLocation;
|
||||
|
||||
public SwaggerContext(Swagger2MarkupConfig config,
|
||||
Swagger2MarkupExtensionRegistry extensionRegistry,
|
||||
Swagger schema, URI swaggerLocation, Labels labels) {
|
||||
super(config, extensionRegistry, schema, swaggerLocation, labels);
|
||||
Context(Swagger2MarkupConfig config, Swagger swagger, URI swaggerLocation) {
|
||||
this.config = config;
|
||||
this.extensionRegistry = extensionRegistry;
|
||||
this.swagger = swagger;
|
||||
this.swaggerLocation = swaggerLocation;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Swagger2MarkupConfig getConfig() {
|
||||
return config;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Swagger2MarkupExtensionRegistry getExtensionRegistry() {
|
||||
return extensionRegistry;
|
||||
public Swagger getSwagger() {
|
||||
return swagger;
|
||||
}
|
||||
|
||||
public MarkupDocBuilder createMarkupDocBuilder() {
|
||||
MarkupLanguage markupLanguage = null;
|
||||
if (config.getMarkupLanguage() != null) {
|
||||
markupLanguage = MarkupLanguage.valueOf(config.getMarkupLanguage().name());
|
||||
}
|
||||
LineSeparator lineSeparator = null;
|
||||
if (config.getLineSeparator() != null) {
|
||||
lineSeparator = LineSeparator.valueOf(config.getLineSeparator().name());
|
||||
}
|
||||
return MarkupDocBuilders.documentBuilder(markupLanguage, lineSeparator,
|
||||
config.getAsciidocPegdownTimeoutMillis()).withAnchorPrefix(config.getAnchorPrefix());
|
||||
public URI getSwaggerLocation() {
|
||||
return swaggerLocation;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
* Copyright 2016 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@@ -13,47 +13,42 @@
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.spi;
|
||||
package io.github.swagger2markup;
|
||||
|
||||
import io.github.swagger2markup.extension.Schema2MarkupExtensionRegistry;
|
||||
import io.github.swagger2markup.spi.*;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* Extension points registry interface.
|
||||
*/
|
||||
public interface Swagger2MarkupExtensionRegistry extends Schema2MarkupExtensionRegistry {
|
||||
public interface Swagger2MarkupExtensionRegistry {
|
||||
/**
|
||||
* SwaggerModelExtension extension point can be used to preprocess the Swagger model.
|
||||
*
|
||||
* @return registered extensions extending SwaggerModelExtension extension point
|
||||
*/
|
||||
List<SwaggerModelExtension> getSwaggerModelExtensions();
|
||||
|
||||
/**
|
||||
* OverviewDocumentExtension extension point can be used to extend the overview document content.
|
||||
*
|
||||
* @return registered extensions extending OverviewDocumentExtension extension point
|
||||
*/
|
||||
List<OverviewDocumentExtension> getOverviewDocumentExtensions();
|
||||
|
||||
/**
|
||||
* DefinitionsDocumentExtension extension point can be used to extend the definitions document content.
|
||||
*
|
||||
* @return registered extensions extending DefinitionsDocumentExtension extension point
|
||||
*/
|
||||
List<DefinitionsDocumentExtension> getDefinitionsDocumentExtensions();
|
||||
|
||||
/**
|
||||
* SecurityContentExtension extension point can be used to extend the security document content.
|
||||
*
|
||||
* @return registered extensions extending SecurityContentExtension extension point
|
||||
*/
|
||||
List<SecurityDocumentExtension> getSecurityDocumentExtensions();
|
||||
|
||||
/**
|
||||
* PathsDocumentExtension extension point can be used to extend the paths document content.
|
||||
*
|
||||
* @return registered extensions extending PathsDocumentExtension extension point
|
||||
*/
|
||||
List<PathsDocumentExtension> getPathsDocumentExtensions();
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
* Copyright 2016 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@@ -15,51 +15,40 @@
|
||||
*/
|
||||
package io.github.swagger2markup;
|
||||
|
||||
import io.github.swagger2markup.markup.builder.MarkupLanguage;
|
||||
import io.github.swagger2markup.utils.URIUtils;
|
||||
import org.apache.commons.collections4.IteratorUtils;
|
||||
import org.apache.commons.configuration2.Configuration;
|
||||
import org.apache.commons.configuration2.ConfigurationConverter;
|
||||
import org.apache.commons.configuration2.MapConfiguration;
|
||||
import org.apache.commons.configuration2.ex.ConversionException;
|
||||
|
||||
import java.net.URI;
|
||||
import java.nio.file.Path;
|
||||
import java.nio.file.Paths;
|
||||
import java.util.*;
|
||||
import java.util.regex.Pattern;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Optional;
|
||||
import java.util.Properties;
|
||||
|
||||
public class Schema2MarkupProperties {
|
||||
public class Swagger2MarkupProperties {
|
||||
|
||||
/**
|
||||
* Prefix for Swagger2Markup properties
|
||||
*/
|
||||
public static final String PROPERTIES_PREFIX = "swagger2markup";
|
||||
|
||||
public static final String REQUEST_EXAMPLES_FORMAT = PROPERTIES_PREFIX + ".requestExamplesFormat";
|
||||
public static final String REQUEST_EXAMPLES_SOURCE_FORMAT = PROPERTIES_PREFIX + ".requestExamplesSourceFormat";
|
||||
public static final String REQUEST_EXAMPLES_HOST = PROPERTIES_PREFIX + ".requestExamplesHost";
|
||||
public static final String REQUEST_EXAMPLES_SCHEMA = PROPERTIES_PREFIX + ".requestExamplesSchema";
|
||||
public static final String REQUEST_EXAMPLES_HIDE_BASE_PATH = PROPERTIES_PREFIX + ".requestExamplesHideBasePath";
|
||||
public static final String REQUEST_EXAMPLES_QUERY_ARRAY_STYLE = PROPERTIES_PREFIX +".requestExamplesQueryArrayStyle";
|
||||
public static final String REQUEST_EXAMPLES_INCLUDE_ALL_QUERY_PARAMS = PROPERTIES_PREFIX + ".requestExamplesIncludeAllQueryParams";
|
||||
public static final String MARKUP_LANGUAGE = PROPERTIES_PREFIX + ".markupLanguage";
|
||||
public static final String SWAGGER_MARKUP_LANGUAGE = PROPERTIES_PREFIX + ".swaggerMarkupLanguage";
|
||||
public static final String GENERATED_EXAMPLES_ENABLED = PROPERTIES_PREFIX + ".generatedExamplesEnabled";
|
||||
public static final String HOSTNAME_ENABLED = PROPERTIES_PREFIX + ".hostnameEnabled";
|
||||
public static final String BASE_PATH_PREFIX_ENABLED = PROPERTIES_PREFIX + ".basePathPrefixEnabled";
|
||||
public static final String SEPARATED_DEFINITIONS_ENABLED = PROPERTIES_PREFIX + ".separatedDefinitionsEnabled";
|
||||
public static final String SEPARATED_OPERATIONS_ENABLED = PROPERTIES_PREFIX + ".separatedOperationsEnabled";
|
||||
public static final String PATHS_GROUPED_BY = PROPERTIES_PREFIX + ".pathsGroupedBy";
|
||||
public static final String HEADER_REGEX = PROPERTIES_PREFIX + ".headerRegex";
|
||||
public static final String OUTPUT_LANGUAGE = PROPERTIES_PREFIX + ".outputLanguage";
|
||||
public static final String INLINE_SCHEMA_ENABLED = PROPERTIES_PREFIX + ".inlineSchemaEnabled";
|
||||
public static final String INTER_DOCUMENT_CROSS_REFERENCES_ENABLED = PROPERTIES_PREFIX + ".interDocumentCrossReferencesEnabled";
|
||||
public static final String INTER_DOCUMENT_CROSS_REFERENCES_PREFIX = PROPERTIES_PREFIX + ".interDocumentCrossReferencesPrefix";
|
||||
public static final String FLAT_BODY_ENABLED = PROPERTIES_PREFIX + ".flatBodyEnabled";
|
||||
public static final String PATH_SECURITY_SECTION_ENABLED = PROPERTIES_PREFIX + ".pathSecuritySectionEnabled";
|
||||
public static final String ANCHOR_PREFIX = PROPERTIES_PREFIX + ".anchorPrefix";
|
||||
public static final String LIST_DELIMITER = PROPERTIES_PREFIX + ".listDelimiter";
|
||||
public static final String LIST_DELIMITER_ENABLED = PROPERTIES_PREFIX + ".listDelimiterEnabled";
|
||||
public static final String OVERVIEW_DOCUMENT = PROPERTIES_PREFIX + ".overviewDocument";
|
||||
public static final String PATHS_DOCUMENT = PROPERTIES_PREFIX + ".pathsDocument";
|
||||
public static final String DEFINITIONS_DOCUMENT = PROPERTIES_PREFIX + ".definitionsDocument";
|
||||
@@ -73,8 +62,6 @@ public class Schema2MarkupProperties {
|
||||
public static final String PROPERTY_ORDER_BY = PROPERTIES_PREFIX + ".propertyOrderBy";
|
||||
public static final String RESPONSE_ORDER_BY = PROPERTIES_PREFIX + ".responseOrderBy";
|
||||
public static final String LINE_SEPARATOR = PROPERTIES_PREFIX + ".lineSeparator";
|
||||
public static final String PAGE_BREAK_LOCATIONS = PROPERTIES_PREFIX + ".pageBreakLocations";
|
||||
public static final String ASCIIDOC_PEGDOWN_TIMEOUT = PROPERTIES_PREFIX + ".asciidoc.pegdown.timeoutMillis";
|
||||
|
||||
/**
|
||||
* Prefix for Swagger2Markup extension properties
|
||||
@@ -83,76 +70,71 @@ public class Schema2MarkupProperties {
|
||||
|
||||
private final Configuration configuration;
|
||||
|
||||
public Schema2MarkupProperties(Properties properties) {
|
||||
public Swagger2MarkupProperties(Properties properties) {
|
||||
this(ConfigurationConverter.getConfiguration(properties));
|
||||
}
|
||||
|
||||
public Schema2MarkupProperties(Map<String, String> map) {
|
||||
public Swagger2MarkupProperties(Map<String, String> map) {
|
||||
this(new MapConfiguration(map));
|
||||
}
|
||||
|
||||
public Schema2MarkupProperties(Configuration configuration) {
|
||||
public Swagger2MarkupProperties(Configuration configuration){
|
||||
this.configuration = configuration;
|
||||
}
|
||||
|
||||
public Configuration getConfiguration() {
|
||||
return configuration;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an optional String property value associated with the given key.
|
||||
*
|
||||
* @param key the property name to resolve
|
||||
*
|
||||
* @return The string property
|
||||
*/
|
||||
public Optional<String> getString(String key) {
|
||||
public Optional<String> getString(String key){
|
||||
return Optional.ofNullable(configuration.getString(key));
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the String property value associated with the given key, or
|
||||
* {@code defaultValue} if the key cannot be resolved.
|
||||
*
|
||||
* @param key the property name to resolve
|
||||
* @param key the property name to resolve
|
||||
* @param defaultValue the default value to return if no value is found
|
||||
*
|
||||
* @return The string property
|
||||
*/
|
||||
public String getString(String key, String defaultValue) {
|
||||
public String getString(String key, String defaultValue){
|
||||
return configuration.getString(key, defaultValue);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the int property value associated with the given key, or
|
||||
* {@code defaultValue} if the key cannot be resolved.
|
||||
*
|
||||
* @param key the property name to resolve
|
||||
* @param key the property name to resolve
|
||||
* @param defaultValue the default value to return if no value is found
|
||||
*
|
||||
* @return The int property
|
||||
*/
|
||||
public int getInt(String key, int defaultValue) {
|
||||
public int getInt(String key, int defaultValue){
|
||||
return configuration.getInt(key, defaultValue);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an optional Integer property value associated with the given key.
|
||||
*
|
||||
* @param key the property name to resolve
|
||||
*
|
||||
* @return An optional Integer property
|
||||
*/
|
||||
public Optional<Integer> getInteger(String key) {
|
||||
public Optional<Integer> getInteger(String key){
|
||||
return Optional.ofNullable(configuration.getInteger(key, null));
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the int property value associated with the given key (never {@code null}).
|
||||
*
|
||||
* @param key the property name to resolve
|
||||
* @return The int property
|
||||
* @throws IllegalStateException if the key cannot be
|
||||
*
|
||||
* @return The int property
|
||||
*/
|
||||
public int getRequiredInt(String key) {
|
||||
public int getRequiredInt(String key){
|
||||
Optional<Integer> value = getInteger(key);
|
||||
if (value.isPresent()) {
|
||||
if(value.isPresent()){
|
||||
return value.get();
|
||||
}
|
||||
throw new IllegalStateException(String.format("required key [%s] not found", key));
|
||||
@@ -160,16 +142,15 @@ public class Schema2MarkupProperties {
|
||||
|
||||
/**
|
||||
* Return the boolean property value associated with the given key (never {@code null}).
|
||||
*
|
||||
* @param key the property name to resolve
|
||||
* @return The boolean property
|
||||
* @throws IllegalStateException if the key cannot be resolved
|
||||
*
|
||||
* @return The boolean property
|
||||
*/
|
||||
public boolean getRequiredBoolean(String key) {
|
||||
public boolean getRequiredBoolean(String key){
|
||||
Boolean value = configuration.getBoolean(key, null);
|
||||
if (value != null) {
|
||||
if(value != null){
|
||||
return value;
|
||||
} else {
|
||||
}else{
|
||||
throw new IllegalStateException(String.format("required key [%s] not found", key));
|
||||
}
|
||||
}
|
||||
@@ -177,40 +158,43 @@ public class Schema2MarkupProperties {
|
||||
/**
|
||||
* Return the boolean property value associated with the given key, or
|
||||
* {@code defaultValue} if the key cannot be resolved.
|
||||
*
|
||||
* @param key the property name to resolve
|
||||
* @param key the property name to resolve
|
||||
* @param defaultValue the default value to return if no value is found
|
||||
*
|
||||
* @return The boolean property
|
||||
*/
|
||||
public boolean getBoolean(String key, boolean defaultValue) {
|
||||
public boolean getBoolean(String key, boolean defaultValue){
|
||||
return configuration.getBoolean(key, defaultValue);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the URI property value associated with the given key, or
|
||||
* {@code defaultValue} if the key cannot be resolved.
|
||||
*
|
||||
* @param key the property name to resolve
|
||||
* @return The URI property
|
||||
* @throws IllegalStateException if the value cannot be mapped to the enum
|
||||
*
|
||||
* @return The URI property
|
||||
*/
|
||||
public Optional<URI> getURI(String key) {
|
||||
public Optional<URI> getURI(String key){
|
||||
Optional<String> property = getString(key);
|
||||
return property.map(URIUtils::create);
|
||||
if(property.isPresent()){
|
||||
return Optional.of(URIUtils.create(property.get()));
|
||||
}else{
|
||||
return Optional.empty();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the URI property value associated with the given key (never {@code null}).
|
||||
*
|
||||
* @param key the property name to resolve
|
||||
* @return The URI property
|
||||
* @throws IllegalStateException if the key cannot be resolved
|
||||
*
|
||||
* @return The URI property
|
||||
*/
|
||||
public URI getRequiredURI(String key) {
|
||||
public URI getRequiredURI(String key){
|
||||
Optional<String> property = getString(key);
|
||||
if (property.isPresent()) {
|
||||
if(property.isPresent()){
|
||||
return URIUtils.create(property.get());
|
||||
} else {
|
||||
}else{
|
||||
throw new IllegalStateException(String.format("required key [%s] not found", key));
|
||||
}
|
||||
}
|
||||
@@ -218,126 +202,107 @@ public class Schema2MarkupProperties {
|
||||
/**
|
||||
* Return the Path property value associated with the given key, or
|
||||
* {@code defaultValue} if the key cannot be resolved.
|
||||
*
|
||||
* @param key the property name to resolve
|
||||
* @return The Path property
|
||||
* @throws IllegalStateException if the value cannot be mapped to the enum
|
||||
*/
|
||||
public Optional<Path> getPath(String key) {
|
||||
Optional<String> property = getString(key);
|
||||
return property.map(s -> Paths.get(s));
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a list of Path property values associated with the given key,
|
||||
* or {@code defaultValue} if the key cannot be resolved.
|
||||
*
|
||||
* @param key the property name to resolve
|
||||
* @return The list of Path properties
|
||||
* @throws IllegalStateException if the value cannot be mapped to an array of strings
|
||||
* @return The Path property
|
||||
*/
|
||||
public List<Path> getPathList(String key) {
|
||||
List<Path> pathList = new ArrayList<>();
|
||||
|
||||
try {
|
||||
String[] stringList = configuration.getStringArray(key);
|
||||
|
||||
for (String pathStr : stringList) {
|
||||
pathList.add(Paths.get(pathStr));
|
||||
}
|
||||
} catch (ConversionException ce) {
|
||||
throw new IllegalStateException(String.format("requested key [%s] is not convertable to an array", key));
|
||||
public Optional<Path> getPath(String key){
|
||||
Optional<String> property = getString(key);
|
||||
if(property.isPresent()){
|
||||
return Optional.of(Paths.get(property.get()));
|
||||
}else{
|
||||
return Optional.empty();
|
||||
}
|
||||
|
||||
return pathList;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the Path property value associated with the given key (never {@code null}).
|
||||
*
|
||||
* @param key the property name to resolve
|
||||
* @return The Path property
|
||||
* @throws IllegalStateException if the key cannot be resolved
|
||||
*
|
||||
* @return The Path property
|
||||
*/
|
||||
public Path getRequiredPath(String key) {
|
||||
public Path getRequiredPath(String key){
|
||||
Optional<String> property = getString(key);
|
||||
if (property.isPresent()) {
|
||||
if(property.isPresent()){
|
||||
return Paths.get(property.get());
|
||||
} else {
|
||||
}else{
|
||||
throw new IllegalStateException(String.format("required key [%s] not found", key));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the OutputLanguage property value associated with the given key, or
|
||||
* Return the MarkupLanguage property value associated with the given key, or
|
||||
* {@code defaultValue} if the key cannot be resolved.
|
||||
*
|
||||
* @param key the property name to resolve
|
||||
* @return The OutputLanguage property
|
||||
*
|
||||
* @return The MarkupLanguage property
|
||||
*/
|
||||
public Optional<MarkupLanguage> getMarkupLanguage(String key) {
|
||||
public Optional<MarkupLanguage> getMarkupLanguage(String key){
|
||||
Optional<String> property = getString(key);
|
||||
return property.map(MarkupLanguage::valueOf);
|
||||
if(property.isPresent()){
|
||||
return Optional.of(MarkupLanguage.valueOf(property.get()));
|
||||
}else{
|
||||
return Optional.empty();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the OutputLanguage property value associated with the given key (never {@code null}).
|
||||
*
|
||||
* @param key the property name to resolve
|
||||
* @return The OutputLanguage property
|
||||
* Return the MarkupLanguage property value associated with the given key (never {@code null}).
|
||||
* @throws IllegalStateException if the key cannot be resolved
|
||||
*
|
||||
* @return The MarkupLanguage property
|
||||
*/
|
||||
public MarkupLanguage getRequiredMarkupLanguage(String key) {
|
||||
public MarkupLanguage getRequiredMarkupLanguage(String key){
|
||||
return MarkupLanguage.valueOf(configuration.getString(key));
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the Language property value associated with the given key, or
|
||||
* {@code defaultValue} if the key cannot be resolved.
|
||||
*
|
||||
* @param key the property name to resolve
|
||||
*
|
||||
* @return The Language property
|
||||
*/
|
||||
public Language getLanguage(String key) {
|
||||
public Language getLanguage(String key){
|
||||
return Language.valueOf(configuration.getString(key));
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the GroupBy property value associated with the given key, or
|
||||
* {@code defaultValue} if the key cannot be resolved.
|
||||
*
|
||||
* @param key the property name to resolve
|
||||
* @return The GroupBy property
|
||||
* @throws IllegalStateException if the value cannot be mapped to the enum
|
||||
*
|
||||
* @return The GroupBy property
|
||||
*/
|
||||
public GroupBy getGroupBy(String key) {
|
||||
public GroupBy getGroupBy(String key){
|
||||
return GroupBy.valueOf(configuration.getString(key));
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the OrderBy property value associated with the given key, or
|
||||
* {@code defaultValue} if the key cannot be resolved.
|
||||
*
|
||||
* @param key the property name to resolve
|
||||
* @return The OrderBy property
|
||||
* @throws IllegalStateException if the value cannot be mapped to the enum
|
||||
*
|
||||
* @return The OrderBy property
|
||||
*/
|
||||
public OrderBy getOrderBy(String key) {
|
||||
public OrderBy getOrderBy(String key){
|
||||
return OrderBy.valueOf(configuration.getString(key));
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the String property value associated with the given key (never {@code null}).
|
||||
*
|
||||
* @param key the property name to resolve
|
||||
* @return The String property
|
||||
* @throws IllegalStateException if the key cannot be resolved
|
||||
*
|
||||
* @return The String property
|
||||
*/
|
||||
public String getRequiredString(String key) throws IllegalStateException {
|
||||
public String getRequiredString(String key) throws IllegalStateException{
|
||||
Optional<String> property = getString(key);
|
||||
if (property.isPresent()) {
|
||||
if(property.isPresent()){
|
||||
return property.get();
|
||||
} else {
|
||||
}else{
|
||||
throw new IllegalStateException(String.format("required key [%s] not found", key));
|
||||
}
|
||||
}
|
||||
@@ -347,7 +312,7 @@ public class Schema2MarkupProperties {
|
||||
*
|
||||
* @return the list of keys.
|
||||
*/
|
||||
public List<String> getKeys() {
|
||||
public List<String> getKeys(){
|
||||
return IteratorUtils.toList(configuration.getKeys());
|
||||
}
|
||||
|
||||
@@ -364,21 +329,10 @@ public class Schema2MarkupProperties {
|
||||
* interpreted - depends on a concrete implementation.
|
||||
*
|
||||
* @param prefix The prefix to test against.
|
||||
*
|
||||
* @return the list of keys.
|
||||
*/
|
||||
public List<String> getKeys(String prefix) {
|
||||
public List<String> getKeys(String prefix){
|
||||
return IteratorUtils.toList(configuration.getKeys(prefix));
|
||||
}
|
||||
|
||||
public List<PageBreakLocations> getPageBreakLocations(String key) {
|
||||
List<PageBreakLocations> result = configuration.getList(PageBreakLocations.class, key);
|
||||
if (result == null) result = new ArrayList<>();
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
public Optional<Pattern> getHeaderPattern(String key) {
|
||||
Optional<String> property = getString(key);
|
||||
return property.map(Pattern::compile);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,690 @@
|
||||
/*
|
||||
* Copyright 2016 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.builder;
|
||||
|
||||
import com.google.common.base.Function;
|
||||
import com.google.common.collect.Ordering;
|
||||
import io.github.swagger2markup.*;
|
||||
import io.github.swagger2markup.markup.builder.LineSeparator;
|
||||
import io.github.swagger2markup.markup.builder.MarkupLanguage;
|
||||
import io.github.swagger2markup.model.PathOperation;
|
||||
import io.swagger.models.HttpMethod;
|
||||
import io.swagger.models.parameters.Parameter;
|
||||
import org.apache.commons.configuration2.*;
|
||||
import org.apache.commons.configuration2.builder.fluent.Configurations;
|
||||
import org.apache.commons.configuration2.ex.ConfigurationException;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.apache.commons.lang3.Validate;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import java.util.Comparator;
|
||||
import java.util.Map;
|
||||
import java.util.Optional;
|
||||
import java.util.Properties;
|
||||
|
||||
import static io.github.swagger2markup.Swagger2MarkupProperties.*;
|
||||
|
||||
public class Swagger2MarkupConfigBuilder {
|
||||
|
||||
private static final Logger logger = LoggerFactory.getLogger(Swagger2MarkupConfigBuilder.class);
|
||||
|
||||
private static final String PROPERTIES_DEFAULT = "io/github/swagger2markup/config/default.properties";
|
||||
|
||||
static final Ordering<PathOperation> OPERATION_METHOD_NATURAL_ORDERING = Ordering
|
||||
.explicit(HttpMethod.POST, HttpMethod.GET, HttpMethod.PUT, HttpMethod.DELETE, HttpMethod.PATCH, HttpMethod.HEAD, HttpMethod.OPTIONS)
|
||||
.onResultOf(new Function<PathOperation, HttpMethod>() {
|
||||
public HttpMethod apply(PathOperation operation) {
|
||||
return operation.getMethod();
|
||||
}
|
||||
});
|
||||
|
||||
static final Ordering<PathOperation> OPERATION_PATH_NATURAL_ORDERING = Ordering
|
||||
.natural()
|
||||
.onResultOf(new Function<PathOperation, String>() {
|
||||
public String apply(PathOperation operation) {
|
||||
return operation.getPath();
|
||||
}
|
||||
});
|
||||
|
||||
static final Ordering<Parameter> PARAMETER_IN_NATURAL_ORDERING = Ordering
|
||||
.explicit("header", "path", "query", "formData", "body")
|
||||
.onResultOf(new Function<Parameter, String>() {
|
||||
public String apply(Parameter parameter) {
|
||||
return parameter.getIn();
|
||||
}
|
||||
});
|
||||
|
||||
static final Ordering<Parameter> PARAMETER_NAME_NATURAL_ORDERING = Ordering
|
||||
.natural()
|
||||
.onResultOf(new Function<Parameter, String>() {
|
||||
public String apply(Parameter parameter) {
|
||||
return parameter.getName();
|
||||
}
|
||||
});
|
||||
|
||||
DefaultSwagger2MarkupConfig config = new DefaultSwagger2MarkupConfig();
|
||||
|
||||
public Swagger2MarkupConfigBuilder() {
|
||||
this(new PropertiesConfiguration());
|
||||
}
|
||||
|
||||
public Swagger2MarkupConfigBuilder(Properties properties) {
|
||||
this(ConfigurationConverter.getConfiguration(properties));
|
||||
}
|
||||
|
||||
public Swagger2MarkupConfigBuilder(Map<String, String> map) {
|
||||
this(new MapConfiguration(map));
|
||||
}
|
||||
|
||||
public Swagger2MarkupConfigBuilder(Configuration configuration) {
|
||||
CompositeConfiguration compositeConfiguration = new CompositeConfiguration();
|
||||
compositeConfiguration.addConfiguration(new SystemConfiguration());
|
||||
compositeConfiguration.addConfiguration(configuration);
|
||||
compositeConfiguration.addConfiguration(getDefaultConfiguration());
|
||||
|
||||
Swagger2MarkupProperties swagger2MarkupProperties = new Swagger2MarkupProperties(compositeConfiguration);
|
||||
|
||||
config.markupLanguage = swagger2MarkupProperties.getRequiredMarkupLanguage(MARKUP_LANGUAGE);
|
||||
config.swaggerMarkupLanguage = swagger2MarkupProperties.getRequiredMarkupLanguage(SWAGGER_MARKUP_LANGUAGE);
|
||||
config.generatedExamplesEnabled = swagger2MarkupProperties.getRequiredBoolean(GENERATED_EXAMPLES_ENABLED);
|
||||
config.separatedDefinitionsEnabled = swagger2MarkupProperties.getRequiredBoolean(SEPARATED_DEFINITIONS_ENABLED);
|
||||
config.separatedOperationsEnabled = swagger2MarkupProperties.getRequiredBoolean(SEPARATED_OPERATIONS_ENABLED);
|
||||
config.pathsGroupedBy = swagger2MarkupProperties.getGroupBy(PATHS_GROUPED_BY);
|
||||
config.outputLanguage = swagger2MarkupProperties.getLanguage(OUTPUT_LANGUAGE);
|
||||
config.inlineSchemaEnabled = swagger2MarkupProperties.getRequiredBoolean(INLINE_SCHEMA_ENABLED);
|
||||
config.interDocumentCrossReferencesEnabled = swagger2MarkupProperties.getRequiredBoolean(INTER_DOCUMENT_CROSS_REFERENCES_ENABLED);
|
||||
config.interDocumentCrossReferencesPrefix = swagger2MarkupProperties.getString(INTER_DOCUMENT_CROSS_REFERENCES_PREFIX, null);
|
||||
config.flatBodyEnabled = swagger2MarkupProperties.getRequiredBoolean(FLAT_BODY_ENABLED);
|
||||
config.anchorPrefix = swagger2MarkupProperties.getString(ANCHOR_PREFIX, null);
|
||||
config.overviewDocument = swagger2MarkupProperties.getRequiredString(OVERVIEW_DOCUMENT);
|
||||
config.pathsDocument = swagger2MarkupProperties.getRequiredString(PATHS_DOCUMENT);
|
||||
config.definitionsDocument = swagger2MarkupProperties.getRequiredString(DEFINITIONS_DOCUMENT);
|
||||
config.securityDocument = swagger2MarkupProperties.getRequiredString(SECURITY_DOCUMENT);
|
||||
config.separatedOperationsFolder = swagger2MarkupProperties.getRequiredString(SEPARATED_OPERATIONS_FOLDER);
|
||||
config.separatedDefinitionsFolder = swagger2MarkupProperties.getRequiredString(SEPARATED_DEFINITIONS_FOLDER);
|
||||
config.tagOrderBy = swagger2MarkupProperties.getOrderBy(TAG_ORDER_BY);
|
||||
config.operationOrderBy = swagger2MarkupProperties.getOrderBy(OPERATION_ORDER_BY);
|
||||
config.definitionOrderBy = swagger2MarkupProperties.getOrderBy(DEFINITION_ORDER_BY);
|
||||
config.parameterOrderBy = swagger2MarkupProperties.getOrderBy(PARAMETER_ORDER_BY);
|
||||
config.propertyOrderBy = swagger2MarkupProperties.getOrderBy(PROPERTY_ORDER_BY);
|
||||
config.responseOrderBy = swagger2MarkupProperties.getOrderBy(RESPONSE_ORDER_BY);
|
||||
Optional<String> lineSeparator = swagger2MarkupProperties.getString(LINE_SEPARATOR);
|
||||
if(lineSeparator.isPresent() && StringUtils.isNoneBlank(lineSeparator.get())){
|
||||
config.lineSeparator = LineSeparator.valueOf(lineSeparator.get());
|
||||
}
|
||||
|
||||
Configuration swagger2markupConfiguration = compositeConfiguration.subset(PROPERTIES_PREFIX);
|
||||
Configuration extensionsConfiguration = swagger2markupConfiguration.subset(EXTENSION_PREFIX);
|
||||
config.extensionsProperties = new Swagger2MarkupProperties(extensionsConfiguration);
|
||||
}
|
||||
|
||||
/**
|
||||
* Loads the default properties from the classpath.
|
||||
*
|
||||
* @return the default properties
|
||||
*/
|
||||
private Configuration getDefaultConfiguration() {
|
||||
Configurations configs = new Configurations();
|
||||
try {
|
||||
return configs.properties(PROPERTIES_DEFAULT);
|
||||
} catch (ConfigurationException e) {
|
||||
throw new RuntimeException(String.format("Can't load default properties '%s'", PROPERTIES_DEFAULT), e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the Swagger2MarkupConfig.
|
||||
*
|
||||
* @return the Swagger2MarkupConfig
|
||||
*/
|
||||
public Swagger2MarkupConfig build() {
|
||||
buildNaturalOrdering();
|
||||
|
||||
return config;
|
||||
}
|
||||
|
||||
private void buildNaturalOrdering() {
|
||||
if (config.tagOrderBy == OrderBy.NATURAL)
|
||||
config.tagOrdering = Ordering.natural();
|
||||
if (config.operationOrderBy == OrderBy.NATURAL)
|
||||
config.operationOrdering = OPERATION_PATH_NATURAL_ORDERING.compound(OPERATION_METHOD_NATURAL_ORDERING);
|
||||
if (config.definitionOrderBy == OrderBy.NATURAL)
|
||||
config.definitionOrdering = Ordering.natural();
|
||||
if (config.parameterOrderBy == OrderBy.NATURAL)
|
||||
config.parameterOrdering = PARAMETER_IN_NATURAL_ORDERING.compound(PARAMETER_NAME_NATURAL_ORDERING);
|
||||
if (config.propertyOrderBy == OrderBy.NATURAL)
|
||||
config.propertyOrdering = Ordering.natural();
|
||||
if (config.responseOrderBy == OrderBy.NATURAL)
|
||||
config.responseOrdering = Ordering.natural();
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies the markup language which should be used to generate the files.
|
||||
*
|
||||
* @param markupLanguage the markup language which is used to generate the files
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withMarkupLanguage(MarkupLanguage markupLanguage) {
|
||||
Validate.notNull(markupLanguage, "%s must not be null", "markupLanguage");
|
||||
config.markupLanguage = markupLanguage;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies the markup language used in Swagger descriptions.
|
||||
*
|
||||
* @param swaggerMarkupLanguage the markup language used in Swagger descriptions
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withSwaggerMarkupLanguage(MarkupLanguage swaggerMarkupLanguage) {
|
||||
Validate.notNull(swaggerMarkupLanguage, "%s must not be null", "swaggerMarkupLanguage");
|
||||
config.swaggerMarkupLanguage = swaggerMarkupLanguage;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Include generated examples into the documents.
|
||||
*
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withGeneratedExamples() {
|
||||
config.generatedExamplesEnabled = true;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* In addition to the Definitions file, also create separate definition files for each model definition.
|
||||
*
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withSeparatedDefinitions() {
|
||||
config.separatedDefinitionsEnabled = true;
|
||||
return this;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* In addition to the Paths file, also create separate operation files for each operation.
|
||||
*
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withSeparatedOperations() {
|
||||
config.separatedOperationsEnabled = true;
|
||||
return this;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Specifies if the paths should be grouped by tags or stay as-is.
|
||||
*
|
||||
* @param pathsGroupedBy the GroupBy enum
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withPathsGroupedBy(GroupBy pathsGroupedBy) {
|
||||
Validate.notNull(pathsGroupedBy, "%s must not be null", "pathsGroupedBy");
|
||||
config.pathsGroupedBy = pathsGroupedBy;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies labels language of output files.
|
||||
*
|
||||
* @param language the enum
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withOutputLanguage(Language language) {
|
||||
Validate.notNull(language, "%s must not be null", "language");
|
||||
config.outputLanguage = language;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Disable inline schema support.
|
||||
*
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withoutInlineSchema() {
|
||||
config.inlineSchemaEnabled = false;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies tag ordering.<br>
|
||||
* By default tag ordering == {@link io.github.swagger2markup.OrderBy#NATURAL}.<br>
|
||||
* Use {@link #withTagOrdering(Comparator)} to set a custom ordering.
|
||||
*
|
||||
* @param orderBy tag ordering
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withTagOrdering(OrderBy orderBy) {
|
||||
Validate.notNull(orderBy, "%s must not be null", "orderBy");
|
||||
Validate.isTrue(orderBy != OrderBy.CUSTOM, "You must provide a custom comparator if orderBy == OrderBy.CUSTOM");
|
||||
config.tagOrderBy = orderBy;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies a custom comparator function to order tags.
|
||||
*
|
||||
* @param tagOrdering tag ordering
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withTagOrdering(Comparator<String> tagOrdering) {
|
||||
Validate.notNull(tagOrdering, "%s must not be null", "tagOrdering");
|
||||
config.tagOrderBy = OrderBy.CUSTOM;
|
||||
config.tagOrdering = tagOrdering;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies operation ordering.<br>
|
||||
* By default operation ordering == {@link io.github.swagger2markup.OrderBy#AS_IS}.<br>
|
||||
* Use {@link #withOperationOrdering(Comparator)} to set a custom ordering.
|
||||
*
|
||||
* @param orderBy operation ordering
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withOperationOrdering(OrderBy orderBy) {
|
||||
Validate.notNull(orderBy, "%s must not be null", "orderBy");
|
||||
Validate.isTrue(orderBy != OrderBy.CUSTOM, "You must provide a custom comparator if orderBy == OrderBy.CUSTOM");
|
||||
config.operationOrderBy = orderBy;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies a custom comparator function to order operations.
|
||||
*
|
||||
* @param operationOrdering operation ordering
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withOperationOrdering(Comparator<PathOperation> operationOrdering) {
|
||||
Validate.notNull(operationOrdering, "%s must not be null", "operationOrdering");
|
||||
config.operationOrderBy = OrderBy.CUSTOM;
|
||||
config.operationOrdering = operationOrdering;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies definition ordering.<br>
|
||||
* By default definition ordering == {@link io.github.swagger2markup.OrderBy#NATURAL}.<br>
|
||||
* Use {@link #withDefinitionOrdering(Comparator)} to set a custom ordering.
|
||||
*
|
||||
* @param orderBy definition ordering
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withDefinitionOrdering(OrderBy orderBy) {
|
||||
Validate.notNull(orderBy, "%s must not be null", "orderBy");
|
||||
Validate.isTrue(orderBy != OrderBy.CUSTOM, "You must provide a custom comparator if orderBy == OrderBy.CUSTOM");
|
||||
config.definitionOrderBy = orderBy;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies a custom comparator function to order definitions.
|
||||
*
|
||||
* @param definitionOrdering definition ordering
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withDefinitionOrdering(Comparator<String> definitionOrdering) {
|
||||
Validate.notNull(definitionOrdering, "%s must not be null", "definitionOrdering");
|
||||
config.definitionOrderBy = OrderBy.CUSTOM;
|
||||
config.definitionOrdering = definitionOrdering;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies parameter ordering.<br>
|
||||
* By default parameter ordering == {@link OrderBy#NATURAL}.<br>
|
||||
* Use {@link #withParameterOrdering(Comparator)} to set a custom ordering.
|
||||
*
|
||||
* @param orderBy parameter ordering
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withParameterOrdering(OrderBy orderBy) {
|
||||
Validate.notNull(orderBy, "%s must not be null", "orderBy");
|
||||
Validate.isTrue(orderBy != OrderBy.CUSTOM, "You must provide a custom comparator if orderBy == OrderBy.CUSTOM");
|
||||
config.parameterOrderBy = orderBy;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies a custom comparator function to order parameters.
|
||||
*
|
||||
* @param parameterOrdering parameter ordering
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withParameterOrdering(Comparator<Parameter> parameterOrdering) {
|
||||
Validate.notNull(parameterOrdering, "%s must not be null", "parameterOrdering");
|
||||
|
||||
config.parameterOrderBy = OrderBy.CUSTOM;
|
||||
config.parameterOrdering = parameterOrdering;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies property ordering.<br>
|
||||
* By default property ordering == {@link io.github.swagger2markup.OrderBy#NATURAL}.<br>
|
||||
* Use {@link #withPropertyOrdering(Comparator)} to set a custom ordering.
|
||||
*
|
||||
* @param orderBy property ordering
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withPropertyOrdering(OrderBy orderBy) {
|
||||
Validate.notNull(orderBy, "%s must not be null", "orderBy");
|
||||
Validate.isTrue(orderBy != OrderBy.CUSTOM, "You must provide a custom comparator if orderBy == OrderBy.CUSTOM");
|
||||
config.propertyOrderBy = orderBy;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies a custom comparator function to order properties.
|
||||
*
|
||||
* @param propertyOrdering property ordering
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withPropertyOrdering(Comparator<String> propertyOrdering) {
|
||||
Validate.notNull(propertyOrdering, "%s must not be null", "propertyOrdering");
|
||||
|
||||
config.propertyOrderBy = OrderBy.CUSTOM;
|
||||
config.propertyOrdering = propertyOrdering;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies response ordering.<br>
|
||||
* By default response ordering == {@link io.github.swagger2markup.OrderBy#NATURAL}.<br>
|
||||
* Use {@link #withResponseOrdering(Comparator)} to set a custom ordering.
|
||||
*
|
||||
* @param orderBy response ordering
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withResponseOrdering(OrderBy orderBy) {
|
||||
Validate.notNull(orderBy, "%s must not be null", "orderBy");
|
||||
Validate.isTrue(orderBy != OrderBy.CUSTOM, "You must provide a custom comparator if orderBy == OrderBy.CUSTOM");
|
||||
config.responseOrderBy = orderBy;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies a custom comparator function to order responses.
|
||||
*
|
||||
* @param responseOrdering response ordering
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withResponseOrdering(Comparator<String> responseOrdering) {
|
||||
Validate.notNull(responseOrdering, "%s must not be null", "responseOrdering");
|
||||
|
||||
config.responseOrderBy = OrderBy.CUSTOM;
|
||||
config.responseOrdering = responseOrdering;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enable use of inter-document cross-references when needed.
|
||||
*
|
||||
* @param prefix Prefix to document in all inter-document cross-references.
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withInterDocumentCrossReferences(String prefix) {
|
||||
Validate.notNull(prefix, "%s must not be null", "prefix");
|
||||
config.interDocumentCrossReferencesEnabled = true;
|
||||
config.interDocumentCrossReferencesPrefix = prefix;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enable use of inter-document cross-references when needed.
|
||||
*
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withInterDocumentCrossReferences() {
|
||||
config.interDocumentCrossReferencesEnabled = true;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Optionally isolate the body parameter, if any, from other parameters.
|
||||
*
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withFlatBody() {
|
||||
config.flatBodyEnabled = true;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Optionally prefix all anchors for uniqueness.
|
||||
*
|
||||
* @param anchorPrefix anchor prefix.
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withAnchorPrefix(String anchorPrefix) {
|
||||
Validate.notNull(anchorPrefix, "%s must no be null", "anchorPrefix");
|
||||
config.anchorPrefix = anchorPrefix;
|
||||
return this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specifies the line separator which should be used.
|
||||
*
|
||||
* @param lineSeparator the lineSeparator
|
||||
* @return this builder
|
||||
*/
|
||||
public Swagger2MarkupConfigBuilder withLineSeparator(LineSeparator lineSeparator) {
|
||||
Validate.notNull(lineSeparator, "%s must no be null", "lineSeparator");
|
||||
config.lineSeparator = lineSeparator;
|
||||
return this;
|
||||
}
|
||||
|
||||
static class DefaultSwagger2MarkupConfig implements Swagger2MarkupConfig{
|
||||
|
||||
private MarkupLanguage markupLanguage;
|
||||
private MarkupLanguage swaggerMarkupLanguage;
|
||||
private boolean generatedExamplesEnabled;
|
||||
private boolean separatedDefinitionsEnabled;
|
||||
private boolean separatedOperationsEnabled;
|
||||
private GroupBy pathsGroupedBy;
|
||||
private Language outputLanguage;
|
||||
private boolean inlineSchemaEnabled;
|
||||
private OrderBy tagOrderBy;
|
||||
private Comparator<String> tagOrdering;
|
||||
private OrderBy operationOrderBy;
|
||||
private Comparator<PathOperation> operationOrdering;
|
||||
private OrderBy definitionOrderBy;
|
||||
private Comparator<String> definitionOrdering;
|
||||
private OrderBy parameterOrderBy;
|
||||
private Comparator<Parameter> parameterOrdering;
|
||||
private OrderBy propertyOrderBy;
|
||||
private Comparator<String> propertyOrdering;
|
||||
private OrderBy responseOrderBy;
|
||||
private Comparator<String> responseOrdering;
|
||||
private boolean interDocumentCrossReferencesEnabled;
|
||||
private String interDocumentCrossReferencesPrefix;
|
||||
private boolean flatBodyEnabled;
|
||||
private String anchorPrefix;
|
||||
private LineSeparator lineSeparator;
|
||||
|
||||
private String overviewDocument;
|
||||
private String pathsDocument;
|
||||
private String definitionsDocument;
|
||||
private String securityDocument;
|
||||
private String separatedOperationsFolder;
|
||||
private String separatedDefinitionsFolder;
|
||||
|
||||
private Swagger2MarkupProperties extensionsProperties;
|
||||
|
||||
@Override
|
||||
public MarkupLanguage getMarkupLanguage() {
|
||||
return markupLanguage;
|
||||
}
|
||||
|
||||
@Override
|
||||
public MarkupLanguage getSwaggerMarkupLanguage() {
|
||||
return swaggerMarkupLanguage;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isGeneratedExamplesEnabled() {
|
||||
return generatedExamplesEnabled;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isSeparatedDefinitionsEnabled() {
|
||||
return separatedDefinitionsEnabled;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isSeparatedOperationsEnabled() {
|
||||
return separatedOperationsEnabled;
|
||||
}
|
||||
|
||||
@Override
|
||||
public GroupBy getPathsGroupedBy() {
|
||||
return pathsGroupedBy;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Language getOutputLanguage() {
|
||||
return outputLanguage;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isInlineSchemaEnabled() {
|
||||
return inlineSchemaEnabled;
|
||||
}
|
||||
|
||||
@Override
|
||||
public OrderBy getTagOrderBy() {
|
||||
return tagOrderBy;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Comparator<String> getTagOrdering() {
|
||||
return tagOrdering;
|
||||
}
|
||||
|
||||
@Override
|
||||
public OrderBy getOperationOrderBy() {
|
||||
return operationOrderBy;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Comparator<PathOperation> getOperationOrdering() {
|
||||
return operationOrdering;
|
||||
}
|
||||
|
||||
@Override
|
||||
public OrderBy getDefinitionOrderBy() {
|
||||
return definitionOrderBy;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Comparator<String> getDefinitionOrdering() {
|
||||
return definitionOrdering;
|
||||
}
|
||||
|
||||
@Override
|
||||
public OrderBy getParameterOrderBy() {
|
||||
return parameterOrderBy;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Comparator<Parameter> getParameterOrdering() {
|
||||
return parameterOrdering;
|
||||
}
|
||||
|
||||
@Override
|
||||
public OrderBy getPropertyOrderBy() {
|
||||
return propertyOrderBy;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Comparator<String> getPropertyOrdering() {
|
||||
return propertyOrdering;
|
||||
}
|
||||
|
||||
@Override
|
||||
public OrderBy getResponseOrderBy() {
|
||||
return responseOrderBy;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Comparator<String> getResponseOrdering() {
|
||||
return responseOrdering;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isInterDocumentCrossReferencesEnabled() {
|
||||
return interDocumentCrossReferencesEnabled;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getInterDocumentCrossReferencesPrefix() {
|
||||
return interDocumentCrossReferencesPrefix;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean isFlatBodyEnabled() {
|
||||
return flatBodyEnabled;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getAnchorPrefix() {
|
||||
return anchorPrefix;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getOverviewDocument() {
|
||||
return overviewDocument;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getPathsDocument() {
|
||||
return pathsDocument;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getDefinitionsDocument() {
|
||||
return definitionsDocument;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getSecurityDocument() {
|
||||
return securityDocument;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getSeparatedOperationsFolder() {
|
||||
return separatedOperationsFolder;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String getSeparatedDefinitionsFolder() {
|
||||
return separatedDefinitionsFolder;
|
||||
}
|
||||
|
||||
@Override
|
||||
public LineSeparator getLineSeparator() {
|
||||
return lineSeparator;
|
||||
}
|
||||
|
||||
@Override
|
||||
public Swagger2MarkupProperties getExtensionsProperties() {
|
||||
return extensionsProperties;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright 2017 Robert Winkler
|
||||
* Copyright 2016 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@@ -16,6 +16,7 @@
|
||||
|
||||
package io.github.swagger2markup.builder;
|
||||
|
||||
import io.github.swagger2markup.Swagger2MarkupExtensionRegistry;
|
||||
import io.github.swagger2markup.spi.*;
|
||||
|
||||
import java.util.List;
|
||||
@@ -70,7 +71,7 @@ public class Swagger2MarkupExtensionRegistryBuilder {
|
||||
return this;
|
||||
}
|
||||
|
||||
static class DefaultSwagger2MarkupExtensionRegistry implements Swagger2MarkupExtensionRegistry {
|
||||
static class DefaultSwagger2MarkupExtensionRegistry implements Swagger2MarkupExtensionRegistry{
|
||||
|
||||
private Context context;
|
||||
|
||||
@@ -79,44 +80,44 @@ public class Swagger2MarkupExtensionRegistryBuilder {
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<SwaggerModelExtension> getSwaggerModelExtensions() {
|
||||
public List<SwaggerModelExtension> getSwaggerModelExtensions(){
|
||||
return context.swaggerModelExtensions;
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<OverviewDocumentExtension> getOverviewDocumentExtensions() {
|
||||
public List<OverviewDocumentExtension> getOverviewDocumentExtensions(){
|
||||
return context.overviewDocumentExtensions;
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<DefinitionsDocumentExtension> getDefinitionsDocumentExtensions() {
|
||||
public List<DefinitionsDocumentExtension> getDefinitionsDocumentExtensions(){
|
||||
return context.definitionsDocumentExtensions;
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<SecurityDocumentExtension> getSecurityDocumentExtensions() {
|
||||
public List<SecurityDocumentExtension> getSecurityDocumentExtensions(){
|
||||
return context.securityDocumentExtensions;
|
||||
}
|
||||
|
||||
@Override
|
||||
public List<PathsDocumentExtension> getPathsDocumentExtensions() {
|
||||
public List<PathsDocumentExtension> getPathsDocumentExtensions(){
|
||||
return context.pathsDocumentExtensions;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
private static class Context {
|
||||
final List<SwaggerModelExtension> swaggerModelExtensions;
|
||||
final List<OverviewDocumentExtension> overviewDocumentExtensions;
|
||||
final List<DefinitionsDocumentExtension> definitionsDocumentExtensions;
|
||||
final List<PathsDocumentExtension> pathsDocumentExtensions;
|
||||
final List<SecurityDocumentExtension> securityDocumentExtensions;
|
||||
public final List<SwaggerModelExtension> swaggerModelExtensions;
|
||||
public final List<OverviewDocumentExtension> overviewDocumentExtensions;
|
||||
public final List<DefinitionsDocumentExtension> definitionsDocumentExtensions;
|
||||
public final List<PathsDocumentExtension> pathsDocumentExtensions;
|
||||
public final List<SecurityDocumentExtension> securityDocumentExtensions;
|
||||
|
||||
Context(List<SwaggerModelExtension> swaggerModelExtensions,
|
||||
List<OverviewDocumentExtension> overviewDocumentExtensions,
|
||||
List<DefinitionsDocumentExtension> definitionsDocumentExtensions,
|
||||
List<PathsDocumentExtension> pathsDocumentExtensions,
|
||||
List<SecurityDocumentExtension> securityDocumentExtensions) {
|
||||
public Context(List<SwaggerModelExtension> swaggerModelExtensions,
|
||||
List<OverviewDocumentExtension> overviewDocumentExtensions,
|
||||
List<DefinitionsDocumentExtension> definitionsDocumentExtensions,
|
||||
List<PathsDocumentExtension> pathsDocumentExtensions,
|
||||
List<SecurityDocumentExtension> securityDocumentExtensions){
|
||||
this.swaggerModelExtensions = swaggerModelExtensions;
|
||||
this.overviewDocumentExtensions = overviewDocumentExtensions;
|
||||
this.definitionsDocumentExtensions = definitionsDocumentExtensions;
|
||||
@@ -124,4 +125,4 @@ public class Swagger2MarkupExtensionRegistryBuilder {
|
||||
this.securityDocumentExtensions = securityDocumentExtensions;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,61 @@
|
||||
/*
|
||||
* Copyright 2016 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.internal.document;
|
||||
|
||||
import io.github.swagger2markup.markup.builder.MarkupDocBuilder;
|
||||
|
||||
import java.nio.charset.Charset;
|
||||
import java.nio.file.OpenOption;
|
||||
import java.nio.file.Path;
|
||||
|
||||
public class MarkupDocument {
|
||||
|
||||
private MarkupDocBuilder markupDocBuilder;
|
||||
|
||||
public MarkupDocument(MarkupDocBuilder markupDocBuilder) {
|
||||
this.markupDocBuilder = markupDocBuilder;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a string representation of the document.
|
||||
*/
|
||||
public String toString() {
|
||||
return markupDocBuilder.toString();
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes the content of the builder to a file.<br>
|
||||
* An extension identifying the markup language will be automatically added to file name.
|
||||
*
|
||||
* @param file the generated file
|
||||
* @param charset the the charset to use for encoding
|
||||
* @param options the file open options
|
||||
*/
|
||||
public void writeToFile(Path file, Charset charset, OpenOption... options) {
|
||||
markupDocBuilder.writeToFile(file, charset, options);
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes the content of the builder to a file.
|
||||
*
|
||||
* @param file the generated file
|
||||
* @param charset the the charset to use for encoding
|
||||
* @param options the file open options
|
||||
*/
|
||||
public void writeToFileWithoutExtension(Path file, Charset charset, OpenOption... options) {
|
||||
markupDocBuilder.writeToFileWithoutExtension(file, charset, options);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,336 @@
|
||||
/*
|
||||
* Copyright 2016 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.internal.document.builder;
|
||||
|
||||
import io.github.swagger2markup.Swagger2MarkupConverter;
|
||||
import io.github.swagger2markup.Swagger2MarkupExtensionRegistry;
|
||||
import io.github.swagger2markup.internal.document.MarkupDocument;
|
||||
import io.github.swagger2markup.internal.type.ObjectType;
|
||||
import io.github.swagger2markup.internal.type.ObjectTypePolymorphism;
|
||||
import io.github.swagger2markup.internal.type.Type;
|
||||
import io.github.swagger2markup.internal.utils.ModelUtils;
|
||||
import io.github.swagger2markup.markup.builder.MarkupDocBuilder;
|
||||
import io.github.swagger2markup.spi.DefinitionsDocumentExtension;
|
||||
import io.swagger.models.Model;
|
||||
import org.apache.commons.collections4.CollectionUtils;
|
||||
import org.apache.commons.collections4.MapUtils;
|
||||
import org.apache.commons.lang3.StringUtils;
|
||||
import org.apache.commons.lang3.Validate;
|
||||
|
||||
import java.io.File;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.nio.file.Path;
|
||||
import java.util.*;
|
||||
|
||||
import static io.github.swagger2markup.internal.utils.MapUtils.toKeySet;
|
||||
import static io.github.swagger2markup.spi.DefinitionsDocumentExtension.Context;
|
||||
import static io.github.swagger2markup.spi.DefinitionsDocumentExtension.Position;
|
||||
import static io.github.swagger2markup.utils.IOUtils.normalizeName;
|
||||
import static org.apache.commons.lang3.StringUtils.defaultString;
|
||||
import static org.apache.commons.lang3.StringUtils.isNotBlank;
|
||||
|
||||
/**
|
||||
* @author Robert Winkler
|
||||
*/
|
||||
public class DefinitionsDocumentBuilder extends MarkupDocumentBuilder {
|
||||
|
||||
/* Discriminator is only displayed for inheriting definitions */
|
||||
private static final boolean ALWAYS_DISPLAY_DISCRIMINATOR = false;
|
||||
|
||||
private static final String DEFINITIONS_ANCHOR = "definitions";
|
||||
private final String DEFINITIONS;
|
||||
private final String DISCRIMINATOR_COLUMN;
|
||||
private final String POLYMORPHISM_COLUMN;
|
||||
private final Map<ObjectTypePolymorphism.Nature, String> POLYMORPHISM_NATURE;
|
||||
private final String TYPE_COLUMN;
|
||||
private static final List<String> IGNORED_DEFINITIONS = Collections.singletonList("Void");
|
||||
|
||||
public DefinitionsDocumentBuilder(Swagger2MarkupConverter.Context context, Swagger2MarkupExtensionRegistry extensionRegistry, Path outputPath) {
|
||||
super(context, extensionRegistry, outputPath);
|
||||
|
||||
ResourceBundle labels = ResourceBundle.getBundle("io/github/swagger2markup/lang/labels", config.getOutputLanguage().toLocale());
|
||||
DEFINITIONS = labels.getString("definitions");
|
||||
POLYMORPHISM_COLUMN = labels.getString("polymorphism.column");
|
||||
DISCRIMINATOR_COLUMN = labels.getString("polymorphism.discriminator");
|
||||
POLYMORPHISM_NATURE = new HashMap<ObjectTypePolymorphism.Nature, String>() {{
|
||||
put(ObjectTypePolymorphism.Nature.COMPOSITION, labels.getString("polymorphism.nature.COMPOSITION"));
|
||||
put(ObjectTypePolymorphism.Nature.INHERITANCE, labels.getString("polymorphism.nature.INHERITANCE"));
|
||||
}};
|
||||
TYPE_COLUMN = labels.getString("type_column");
|
||||
|
||||
if (config.isSeparatedDefinitionsEnabled()) {
|
||||
if (logger.isDebugEnabled()) {
|
||||
logger.debug("Create separated definition files is enabled.");
|
||||
}
|
||||
Validate.notNull(outputPath, "Output directory is required for separated definition files!");
|
||||
} else {
|
||||
if (logger.isDebugEnabled()) {
|
||||
logger.debug("Create separated definition files is disabled.");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the definitions MarkupDocument.
|
||||
*
|
||||
* @return the definitions MarkupDocument
|
||||
*/
|
||||
@Override
|
||||
public MarkupDocument build() {
|
||||
if (MapUtils.isNotEmpty(globalContext.getSwagger().getDefinitions())) {
|
||||
applyDefinitionsDocumentExtension(new Context(Position.DOCUMENT_BEFORE, this.markupDocBuilder));
|
||||
buildDefinitionsTitle(DEFINITIONS);
|
||||
applyDefinitionsDocumentExtension(new Context(Position.DOCUMENT_BEGIN, this.markupDocBuilder));
|
||||
buildDefinitionsSection();
|
||||
applyDefinitionsDocumentExtension(new Context(Position.DOCUMENT_END, this.markupDocBuilder));
|
||||
applyDefinitionsDocumentExtension(new Context(Position.DOCUMENT_AFTER, this.markupDocBuilder));
|
||||
}
|
||||
return new MarkupDocument(markupDocBuilder);
|
||||
}
|
||||
|
||||
private void buildDefinitionsSection() {
|
||||
Set<String> definitionNames = toKeySet(globalContext.getSwagger().getDefinitions(), config.getDefinitionOrdering());
|
||||
for (String definitionName : definitionNames) {
|
||||
Model model = globalContext.getSwagger().getDefinitions().get(definitionName);
|
||||
if (isNotBlank(definitionName)) {
|
||||
if (checkThatDefinitionIsNotInIgnoreList(definitionName)) {
|
||||
buildDefinition(definitionName, model);
|
||||
if (logger.isInfoEnabled()) {
|
||||
logger.info("Definition processed : '{}'", definitionName);
|
||||
}
|
||||
} else {
|
||||
if (logger.isDebugEnabled()) {
|
||||
logger.debug("Definition was ignored : '{}'", definitionName);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void buildDefinitionsTitle(String title) {
|
||||
this.markupDocBuilder.sectionTitleWithAnchorLevel1(title, DEFINITIONS_ANCHOR);
|
||||
}
|
||||
|
||||
/**
|
||||
* Apply extension context to all DefinitionsContentExtension
|
||||
*
|
||||
* @param context context
|
||||
*/
|
||||
private void applyDefinitionsDocumentExtension(Context context) {
|
||||
for (DefinitionsDocumentExtension extension : extensionRegistry.getDefinitionsDocumentExtensions()) {
|
||||
extension.apply(context);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Create the definition filename depending on the generation mode
|
||||
*
|
||||
* @param definitionName definition name
|
||||
* @return definition filename
|
||||
*/
|
||||
private String resolveDefinitionDocument(String definitionName) {
|
||||
if (config.isSeparatedDefinitionsEnabled())
|
||||
return new File(config.getSeparatedDefinitionsFolder(), markupDocBuilder.addFileExtension(normalizeName(definitionName))).getPath();
|
||||
else
|
||||
return markupDocBuilder.addFileExtension(config.getDefinitionsDocument());
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate definition files depending on the generation mode
|
||||
*
|
||||
* @param definitionName definition name to process
|
||||
* @param model definition model to process
|
||||
*/
|
||||
private void buildDefinition(String definitionName, Model model) {
|
||||
|
||||
if (config.isSeparatedDefinitionsEnabled()) {
|
||||
MarkupDocBuilder defDocBuilder = copyMarkupDocBuilder();
|
||||
buildDefinition(definitionName, model, defDocBuilder);
|
||||
Path definitionFile = outputPath.resolve(resolveDefinitionDocument(definitionName));
|
||||
defDocBuilder.writeToFileWithoutExtension(definitionFile, StandardCharsets.UTF_8);
|
||||
if (logger.isInfoEnabled()) {
|
||||
logger.info("Separate definition file produced : '{}'", definitionFile);
|
||||
}
|
||||
|
||||
definitionRef(definitionName, this.markupDocBuilder);
|
||||
|
||||
} else {
|
||||
buildDefinition(definitionName, model, this.markupDocBuilder);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks that the definition is not in the list of ignored definitions.
|
||||
*
|
||||
* @param definitionName the name of the definition
|
||||
* @return true if the definition can be processed
|
||||
*/
|
||||
private boolean checkThatDefinitionIsNotInIgnoreList(String definitionName) {
|
||||
return !IGNORED_DEFINITIONS.contains(definitionName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds a concrete definition
|
||||
*
|
||||
* @param definitionName the name of the definition
|
||||
* @param model the Swagger Model of the definition
|
||||
* @param docBuilder the docbuilder do use for output
|
||||
*/
|
||||
private void buildDefinition(String definitionName, Model model, MarkupDocBuilder docBuilder) {
|
||||
applyDefinitionsDocumentExtension(new Context(Position.DEFINITION_BEFORE, docBuilder, definitionName, model));
|
||||
buildDefinitionTitle(definitionName, definitionName, docBuilder);
|
||||
applyDefinitionsDocumentExtension(new Context(Position.DEFINITION_BEGIN, docBuilder, definitionName, model));
|
||||
buildDescriptionParagraph(model, docBuilder);
|
||||
inlineDefinitions(typeSection(definitionName, model, docBuilder), definitionName, docBuilder);
|
||||
applyDefinitionsDocumentExtension(new Context(Position.DEFINITION_END, docBuilder, definitionName, model));
|
||||
applyDefinitionsDocumentExtension(new Context(Position.DEFINITION_AFTER, docBuilder, definitionName, model));
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds a cross-reference to a separated definition file.
|
||||
*
|
||||
* @param definitionName definition name to target
|
||||
* @param docBuilder the docbuilder do use for output
|
||||
*/
|
||||
private void definitionRef(String definitionName, MarkupDocBuilder docBuilder) {
|
||||
buildDefinitionTitle(copyMarkupDocBuilder().crossReference(new DefinitionDocumentResolverDefault().apply(definitionName), definitionName, definitionName).toString(), "ref-" + definitionName, docBuilder);
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds definition title
|
||||
*
|
||||
* @param title definition title
|
||||
* @param anchor optional anchor (null => auto-generate from title)
|
||||
* @param docBuilder the docbuilder do use for output
|
||||
*/
|
||||
private void buildDefinitionTitle(String title, String anchor, MarkupDocBuilder docBuilder) {
|
||||
docBuilder.sectionTitleWithAnchorLevel2(title, anchor);
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Builds the type informations of a definition
|
||||
*
|
||||
* @param definitionName name of the definition to display
|
||||
* @param model model of the definition to display
|
||||
* @param docBuilder the docbuilder do use for output
|
||||
* @return a list of inlined types.
|
||||
*/
|
||||
private List<ObjectType> typeSection(String definitionName, Model model, MarkupDocBuilder docBuilder) {
|
||||
List<ObjectType> inlineDefinitions = new ArrayList<>();
|
||||
Type modelType = ModelUtils.resolveRefType(ModelUtils.getType(model, globalContext.getSwagger().getDefinitions(), new DefinitionDocumentResolverFromDefinition()));
|
||||
|
||||
if (!(modelType instanceof ObjectType)) {
|
||||
modelType = createInlineType(modelType, definitionName, definitionName + " " + "inline", inlineDefinitions);
|
||||
}
|
||||
|
||||
if (modelType instanceof ObjectType) {
|
||||
ObjectType objectType = (ObjectType) modelType;
|
||||
MarkupDocBuilder typeInfos = copyMarkupDocBuilder();
|
||||
switch (objectType.getPolymorphism().getNature()) {
|
||||
case COMPOSITION:
|
||||
typeInfos.italicText(POLYMORPHISM_COLUMN).textLine(COLON + POLYMORPHISM_NATURE.get(objectType.getPolymorphism().getNature()));
|
||||
break;
|
||||
case INHERITANCE:
|
||||
typeInfos.italicText(POLYMORPHISM_COLUMN).textLine(COLON + POLYMORPHISM_NATURE.get(objectType.getPolymorphism().getNature()));
|
||||
typeInfos.italicText(DISCRIMINATOR_COLUMN).textLine(COLON + objectType.getPolymorphism().getDiscriminator());
|
||||
break;
|
||||
case NONE:
|
||||
if (ALWAYS_DISPLAY_DISCRIMINATOR) {
|
||||
if (StringUtils.isNotBlank(objectType.getPolymorphism().getDiscriminator()))
|
||||
typeInfos.italicText(DISCRIMINATOR_COLUMN).textLine(COLON + objectType.getPolymorphism().getDiscriminator());
|
||||
}
|
||||
|
||||
default: break;
|
||||
}
|
||||
|
||||
String typeInfosString = typeInfos.toString();
|
||||
if (StringUtils.isNotBlank(typeInfosString))
|
||||
docBuilder.paragraph(typeInfosString, true);
|
||||
|
||||
inlineDefinitions.addAll(buildPropertiesTable(((ObjectType) modelType).getProperties(), definitionName, new DefinitionDocumentResolverFromDefinition(), docBuilder));
|
||||
} else if (modelType != null) {
|
||||
MarkupDocBuilder typeInfos = copyMarkupDocBuilder();
|
||||
typeInfos.italicText(TYPE_COLUMN).textLine(COLON + modelType.displaySchema(docBuilder));
|
||||
|
||||
docBuilder.paragraph(typeInfos.toString());
|
||||
}
|
||||
|
||||
return inlineDefinitions;
|
||||
}
|
||||
|
||||
private void buildDescriptionParagraph(Model model, MarkupDocBuilder docBuilder) {
|
||||
modelDescription(model, docBuilder);
|
||||
}
|
||||
|
||||
private void modelDescription(Model model, MarkupDocBuilder docBuilder) {
|
||||
String description = model.getDescription();
|
||||
if (isNotBlank(description)) {
|
||||
buildDescriptionParagraph(description, docBuilder);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the title of an inline schema.
|
||||
* Inline definitions should never been referenced in TOC because they have no real existence, so they are just text.
|
||||
*
|
||||
* @param title inline schema title
|
||||
* @param anchor inline schema anchor
|
||||
* @param docBuilder the docbuilder do use for output
|
||||
*/
|
||||
private void addInlineDefinitionTitle(String title, String anchor, MarkupDocBuilder docBuilder) {
|
||||
docBuilder.anchor(anchor, null);
|
||||
docBuilder.newLine();
|
||||
docBuilder.boldTextLine(title);
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds inline schema definitions
|
||||
*
|
||||
* @param definitions all inline definitions to display
|
||||
* @param uniquePrefix unique prefix to prepend to inline object names to enforce unicity
|
||||
* @param docBuilder the docbuilder do use for output
|
||||
*/
|
||||
private void inlineDefinitions(List<ObjectType> definitions, String uniquePrefix, MarkupDocBuilder docBuilder) {
|
||||
if (CollectionUtils.isNotEmpty(definitions)) {
|
||||
for (ObjectType definition : definitions) {
|
||||
addInlineDefinitionTitle(definition.getName(), definition.getUniqueName(), docBuilder);
|
||||
List<ObjectType> localDefinitions = buildPropertiesTable(definition.getProperties(), uniquePrefix, new DefinitionDocumentResolverFromDefinition(), docBuilder);
|
||||
for (ObjectType localDefinition : localDefinitions)
|
||||
inlineDefinitions(Collections.singletonList(localDefinition), localDefinition.getUniqueName(), docBuilder);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Overrides definition document resolver functor for inter-document cross-references from definitions files.
|
||||
* This implementation simplify the path between two definitions because all definitions are in the same path.
|
||||
*/
|
||||
class DefinitionDocumentResolverFromDefinition extends DefinitionDocumentResolverDefault {
|
||||
|
||||
public DefinitionDocumentResolverFromDefinition() {
|
||||
}
|
||||
|
||||
public String apply(String definitionName) {
|
||||
String defaultResolver = super.apply(definitionName);
|
||||
|
||||
if (defaultResolver != null && config.isSeparatedDefinitionsEnabled())
|
||||
return defaultString(config.getInterDocumentCrossReferencesPrefix()) + markupDocBuilder.addFileExtension(normalizeName(definitionName));
|
||||
else
|
||||
return defaultResolver;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,282 @@
|
||||
/*
|
||||
* Copyright 2016 Robert Winkler
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
package io.github.swagger2markup.internal.document.builder;
|
||||
|
||||
import io.github.swagger2markup.Swagger2MarkupConfig;
|
||||
import io.github.swagger2markup.Swagger2MarkupConverter;
|
||||
import io.github.swagger2markup.Swagger2MarkupExtensionRegistry;
|
||||
import io.github.swagger2markup.internal.document.MarkupDocument;
|
||||
import io.github.swagger2markup.internal.type.*;
|
||||
import io.github.swagger2markup.internal.utils.PropertyUtils;
|
||||
import io.github.swagger2markup.markup.builder.MarkupDocBuilder;
|
||||
import io.github.swagger2markup.markup.builder.MarkupDocBuilders;
|
||||
import io.github.swagger2markup.markup.builder.MarkupLanguage;
|
||||
import io.github.swagger2markup.markup.builder.MarkupTableColumn;
|
||||
import io.github.swagger2markup.utils.IOUtils;
|
||||
import io.swagger.models.properties.Property;
|
||||
import io.swagger.util.Json;
|
||||
import org.apache.commons.collections4.MapUtils;
|
||||
import org.apache.commons.lang3.BooleanUtils;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.io.StringReader;
|
||||
import java.nio.file.Path;
|
||||
import java.util.*;
|
||||
|
||||
import static io.github.swagger2markup.internal.utils.MapUtils.toKeySet;
|
||||
import static org.apache.commons.lang3.StringUtils.defaultString;
|
||||
import static org.apache.commons.lang3.StringUtils.isNotBlank;
|
||||
|
||||
/**
|
||||
* @author Robert Winkler
|
||||
*/
|
||||
public abstract class MarkupDocumentBuilder {
|
||||
|
||||
protected static final String COLON = " : ";
|
||||
|
||||
protected final String DEFAULT_COLUMN;
|
||||
protected final String EXAMPLE_COLUMN;
|
||||
protected final String SCHEMA_COLUMN;
|
||||
protected final String NAME_COLUMN;
|
||||
protected final String DESCRIPTION_COLUMN;
|
||||
protected final String SCOPES_COLUMN;
|
||||
protected final String DESCRIPTION;
|
||||
protected final String PRODUCES;
|
||||
protected final String CONSUMES;
|
||||
protected final String TAGS;
|
||||
protected final String NO_CONTENT;
|
||||
protected final String FLAGS_COLUMN;
|
||||
protected final String FLAGS_REQUIRED;
|
||||
protected final String FLAGS_OPTIONAL;
|
||||
protected final String FLAGS_READ_ONLY;
|
||||
|
||||
|
||||
protected Logger logger = LoggerFactory.getLogger(getClass());
|
||||
|
||||
protected Swagger2MarkupConverter.Context globalContext;
|
||||
protected Swagger2MarkupExtensionRegistry extensionRegistry;
|
||||
protected Swagger2MarkupConfig config;
|
||||
protected MarkupDocBuilder markupDocBuilder;
|
||||
protected Path outputPath;
|
||||
|
||||
MarkupDocumentBuilder(Swagger2MarkupConverter.Context globalContext, Swagger2MarkupExtensionRegistry extensionRegistry, Path outputPath) {
|
||||
this.globalContext = globalContext;
|
||||
this.extensionRegistry = extensionRegistry;
|
||||
this.config = globalContext.getConfig();
|
||||
this.outputPath = outputPath;
|
||||
|
||||
this.markupDocBuilder = MarkupDocBuilders.documentBuilder(config.getMarkupLanguage(), config.getLineSeparator()).withAnchorPrefix(config.getAnchorPrefix());
|
||||
|
||||
ResourceBundle labels = ResourceBundle.getBundle("io/github/swagger2markup/lang/labels", config.getOutputLanguage().toLocale());
|
||||
DEFAULT_COLUMN = labels.getString("default_column");
|
||||
EXAMPLE_COLUMN = labels.getString("example_column");
|
||||
FLAGS_COLUMN = labels.getString("flags.column");
|
||||
FLAGS_REQUIRED = labels.getString("flags.required");
|
||||
FLAGS_OPTIONAL = labels.getString("flags.optional");
|
||||
FLAGS_READ_ONLY = labels.getString("flags.read_only");
|
||||
SCHEMA_COLUMN = labels.getString("schema_column");
|
||||
NAME_COLUMN = labels.getString("name_column");
|
||||
DESCRIPTION_COLUMN = labels.getString("description_column");
|
||||
SCOPES_COLUMN = labels.getString("scopes_column");
|
||||
DESCRIPTION = DESCRIPTION_COLUMN;
|
||||
PRODUCES = labels.getString("produces");
|
||||
CONSUMES = labels.getString("consumes");
|
||||
TAGS = labels.getString("tags");
|
||||
NO_CONTENT = labels.getString("no_content");
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds the MarkupDocument.
|
||||
*
|
||||
* @return the built MarkupDocument
|
||||
* @throws IOException if the files to include are not readable
|
||||
*/
|
||||
public abstract MarkupDocument build() throws IOException;
|
||||
|
||||
/**
|
||||
* Returns a RefType to a new inlined type named with {@code name} and {@code uniqueName}.<br>
|
||||
* The returned RefType point to the new inlined type which is added to the {@code inlineDefinitions} collection.<br>
|
||||
* The function is recursive and support collections (ArrayType and MapType).<br>
|
||||
* The function is transparent : {@code type} is returned as-is if type is not inlinable or if !config.isInlineSchemaEnabled().<br>
|
||||
*
|
||||
* @param type type to inline
|
||||
* @param name name of the created inline ObjectType
|
||||
* @param uniqueName unique name of the created inline ObjectType
|
||||
* @param inlineDefinitions a non null collection of inline ObjectType
|
||||
* @return the type referencing the newly created inline ObjectType. Can be a RefType, an ArrayType or a MapType
|
||||
*/
|
||||
protected Type createInlineType(Type type, String name, String uniqueName, List<ObjectType> inlineDefinitions) {
|
||||
if (!config.isInlineSchemaEnabled())
|
||||
return type;
|
||||
|
||||
if (type instanceof ObjectType) {
|
||||
return createInlineObjectType(type, name, uniqueName, inlineDefinitions);
|
||||
} else if (type instanceof ArrayType) {
|
||||
ArrayType arrayType = (ArrayType)type;
|
||||
arrayType.setOfType(createInlineType(arrayType.getOfType(), name, uniqueName, inlineDefinitions));
|
||||
|
||||
return arrayType;
|
||||
} else if (type instanceof MapType) {
|
||||
MapType mapType = (MapType)type;
|
||||
if (mapType.getValueType() instanceof ObjectType)
|
||||
mapType.setValueType(createInlineType(mapType.getValueType(), name, uniqueName, inlineDefinitions));
|
||||
|
||||
return mapType;
|
||||
} else {
|
||||
return type;
|
||||
}
|
||||
}
|
||||
|
||||
protected Type createInlineObjectType(Type type, String name, String uniqueName, List<ObjectType> inlineDefinitions) {
|
||||
if (type instanceof ObjectType) {
|
||||
ObjectType objectType = (ObjectType)type;
|
||||
if (MapUtils.isNotEmpty(objectType.getProperties())) {
|
||||
if (objectType.getName() == null) {
|
||||
objectType.setName(name);
|
||||
objectType.setUniqueName(uniqueName);
|
||||
}
|
||||
inlineDefinitions.add(objectType);
|
||||
return new RefType(objectType);
|
||||
} else
|
||||
return type;
|
||||
} else
|
||||
return type;
|
||||
}
|
||||
|
||||
/**
|
||||
* Build a generic property table
|
||||
*
|
||||
* @param properties properties to display
|
||||
* @param uniquePrefix unique prefix to prepend to inline object names to enforce unicity
|
||||
* @param definitionDocumentResolver definition document resolver to apply to property type cross-reference
|
||||
* @param docBuilder the docbuilder do use for output
|
||||
* @return a list of inline schemas referenced by some properties, for later display
|
||||
*/
|
||||
protected List<ObjectType> buildPropertiesTable(Map<String, Property> properties, String uniquePrefix, DefinitionDocumentResolver definitionDocumentResolver, MarkupDocBuilder docBuilder) {
|
||||
List<ObjectType> inlineDefinitions = new ArrayList<>();
|
||||
List<List<String>> cells = new ArrayList<>();
|
||||
List<MarkupTableColumn> cols = Arrays.asList(
|
||||
new MarkupTableColumn(NAME_COLUMN).withWidthRatio(3).withHeaderColumn(false).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^3"),
|
||||
new MarkupTableColumn(DESCRIPTION_COLUMN).withWidthRatio(11).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^11"),
|
||||
new MarkupTableColumn(SCHEMA_COLUMN).withWidthRatio(4).withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^4"));
|
||||
if (MapUtils.isNotEmpty(properties)) {
|
||||
Set<String> propertyNames = toKeySet(properties, config.getPropertyOrdering());
|
||||
for (String propertyName : propertyNames) {
|
||||
Property property = properties.get(propertyName);
|
||||
Type propertyType = PropertyUtils.getType(property, definitionDocumentResolver);
|
||||
|
||||
propertyType = createInlineType(propertyType, propertyName, uniquePrefix + " " + propertyName, inlineDefinitions);
|
||||
|
||||
Object example = PropertyUtils.getExample(config.isGeneratedExamplesEnabled(), property, markupDocBuilder);
|
||||
|
||||
Object defaultValue = PropertyUtils.getDefaultValue(property);
|
||||
|
||||
MarkupDocBuilder propertyNameContent = copyMarkupDocBuilder();
|
||||
propertyNameContent.boldTextLine(propertyName, true);
|
||||
if (BooleanUtils.isTrue(property.getRequired()))
|
||||
propertyNameContent.italicText(FLAGS_REQUIRED.toLowerCase());
|
||||
else
|
||||
propertyNameContent.italicText(FLAGS_OPTIONAL.toLowerCase());
|
||||
if (BooleanUtils.isTrue(property.getReadOnly())) {
|
||||
propertyNameContent.newLine(true);
|
||||
propertyNameContent.italicText(FLAGS_READ_ONLY.toLowerCase());
|
||||
}
|
||||
|
||||
MarkupDocBuilder descriptionContent = copyMarkupDocBuilder();
|
||||
String description = defaultString(swaggerMarkupDescription(property.getDescription()));
|
||||
if (isNotBlank(description))
|
||||
descriptionContent.text(description);
|
||||
if(defaultValue != null){
|
||||
if (isNotBlank(description))
|
||||
descriptionContent.newLine(true);
|
||||
descriptionContent.boldText(DEFAULT_COLUMN).text(COLON).literalText(Json.pretty(defaultValue));
|
||||
}
|
||||
if (example != null) {
|
||||
if (isNotBlank(description) || defaultValue != null)
|
||||
descriptionContent.newLine(true);
|
||||
descriptionContent.boldText(EXAMPLE_COLUMN).text(COLON).literalText(Json.pretty(example));
|
||||
}
|
||||
|
||||
List<String> content = Arrays.asList(
|
||||
propertyNameContent.toString(),
|
||||
descriptionContent.toString(),
|
||||
propertyType.displaySchema(docBuilder)
|
||||
);
|
||||
cells.add(content);
|
||||
}
|
||||
docBuilder.tableWithColumnSpecs(cols, cells);
|
||||
} else {
|
||||
docBuilder.textLine(NO_CONTENT);
|
||||
}
|
||||
|
||||
return inlineDefinitions;
|
||||
}
|
||||
|
||||
protected MarkupDocBuilder copyMarkupDocBuilder() {
|
||||
return markupDocBuilder.copy(false);
|
||||
}
|
||||
|
||||
protected String boldText(String text) {
|
||||
return copyMarkupDocBuilder().boldText(text).toString();
|
||||
}
|
||||
|
||||
protected String italicText(String text) {
|
||||
return copyMarkupDocBuilder().italicText(text).toString();
|
||||
}
|
||||
|
||||
protected String literalText(String text) {
|
||||
return copyMarkupDocBuilder().literalText(text).toString();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns converted markup text from Swagger.
|
||||
*
|
||||
* @param markupText text to convert, or null
|
||||
* @return converted markup text, or null if {@code markupText} == null
|
||||
*/
|
||||
protected String swaggerMarkupDescription(String markupText) {
|
||||
if (markupText == null)
|
||||
return null;
|
||||
return copyMarkupDocBuilder().importMarkup(new StringReader(markupText), globalContext.getConfig().getSwaggerMarkupLanguage()).toString().trim();
|
||||
}
|
||||
|
||||
protected void buildDescriptionParagraph(String description, MarkupDocBuilder docBuilder) {
|
||||
if (isNotBlank(description)) {
|
||||
docBuilder.paragraph(swaggerMarkupDescription(description));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Default {@code DefinitionDocumentResolver} functor
|
||||
*/
|
||||
class DefinitionDocumentResolverDefault implements DefinitionDocumentResolver {
|
||||
|
||||
public DefinitionDocumentResolverDefault() {
|
||||
}
|
||||
|
||||
public String apply(String definitionName) {
|
||||
if (!config.isInterDocumentCrossReferencesEnabled() || outputPath == null)
|
||||
return null;
|
||||
else if (config.isSeparatedDefinitionsEnabled())
|
||||
return defaultString(config.getInterDocumentCrossReferencesPrefix()) + new File(config.getSeparatedDefinitionsFolder(), markupDocBuilder.addFileExtension(IOUtils.normalizeName(definitionName))).getPath();
|
||||
else
|
||||
return defaultString(config.getInterDocumentCrossReferencesPrefix()) + markupDocBuilder.addFileExtension(config.getDefinitionsDocument());
|
||||
}
|
||||
}
|
||||
}
|
||||