Java MarkupLanguage类代码示例

import io.github.swagger2markup.markup.builder.MarkupLanguage; //导入依赖的package包/类
@Override
public void init(Swagger2MarkupConverter.Context globalContext) {
    Swagger2MarkupProperties extensionsProperties = globalContext.getConfig().getExtensionsProperties();
    contentPath = extensionsProperties.getPathList(extensionId + "." + PROPERTY_CONTENT_PATH);

    if (contentPath.isEmpty()) {
        if (globalContext.getSwaggerLocation() == null || !globalContext.getSwaggerLocation().getScheme().equals("file")) {
            if (logger.isWarnEnabled())
                logger.warn("Disable > DynamicOverviewContentExtension > Can't set default contentPath from swaggerLocation. You have to explicitly configure the content path.");
        } else {
            contentPath.add(Paths.get(globalContext.getSwaggerLocation()).getParent());
        }
    }
    
    Optional<MarkupLanguage> extensionMarkupLanguageProperty = extensionsProperties.getMarkupLanguage(extensionId + "." + PROPERTY_MARKUP_LANGUAGE);
    if (extensionMarkupLanguageProperty.isPresent()) {
        extensionMarkupLanguage = extensionMarkupLanguageProperty.get();
    }
}
 

import io.github.swagger2markup.markup.builder.MarkupLanguage; //导入依赖的package包/类
@Override
public void init(Swagger2MarkupConverter.Context globalContext) {
    Swagger2MarkupProperties extensionsProperties = globalContext.getConfig().getExtensionsProperties();
    contentPath = extensionsProperties.getPathList(extensionId + "." + PROPERTY_CONTENT_PATH);
    
    if (contentPath.isEmpty()) {
        if (globalContext.getSwaggerLocation() == null || !globalContext.getSwaggerLocation().getScheme().equals("file")) {
            if (logger.isWarnEnabled())
                logger.warn("Disable DynamicOperationsContentExtension > Can't set default contentPath from swaggerLocation. You have to explicitly configure the content path.");
        } else {
            contentPath.add(Paths.get(globalContext.getSwaggerLocation()).getParent());
        }
    }

    Optional<MarkupLanguage> extensionMarkupLanguageProperty = extensionsProperties.getMarkupLanguage(extensionId + "." + PROPERTY_MARKUP_LANGUAGE);
    if (extensionMarkupLanguageProperty.isPresent()) {
        extensionMarkupLanguage = extensionMarkupLanguageProperty.get();
    }
}
 

import io.github.swagger2markup.markup.builder.MarkupLanguage; //导入依赖的package包/类
@Override
public void init(Swagger2MarkupConverter.Context globalContext) {
    Swagger2MarkupProperties extensionsProperties = globalContext.getConfig().getExtensionsProperties();
    contentPath = extensionsProperties.getPathList(extensionId + "." + PROPERTY_CONTENT_PATH);
    if (contentPath.isEmpty()) {
        if (globalContext.getSwaggerLocation() == null || !globalContext.getSwaggerLocation().getScheme().equals("file")) {
            if (logger.isWarnEnabled())
                logger.warn("Disable DynamicDefinitionsContentExtension > Can't set default contentPath from swaggerLocation. You have to explicitly configure the content path.");
        } else {
            contentPath.add(Paths.get(globalContext.getSwaggerLocation()).getParent());
        }
    }

    Optional<MarkupLanguage> extensionMarkupLanguageProperty = extensionsProperties.getMarkupLanguage(extensionId + "." + PROPERTY_MARKUP_LANGUAGE);
    if (extensionMarkupLanguageProperty.isPresent()) {
        extensionMarkupLanguage = extensionMarkupLanguageProperty.get();
    }
}
 

import io.github.swagger2markup.markup.builder.MarkupLanguage; //导入依赖的package包/类
@Override
public void init(Swagger2MarkupConverter.Context globalContext) {
    Swagger2MarkupProperties extensionsProperties = globalContext.getConfig().getExtensionsProperties();
    contentPath = extensionsProperties.getPathList(extensionId + "." + PROPERTY_CONTENT_PATH);
   
    if (contentPath.isEmpty()) {
        if (globalContext.getSwaggerLocation() == null || !globalContext.getSwaggerLocation().getScheme().equals("file")) {
            if (logger.isWarnEnabled())
                logger.warn("Disable > DynamicSecurityContentExtension > Can't set default contentPath from swaggerLocation. You have to explicitly configure the content path.");
        } else {
            contentPath = new ArrayList<Path>();
            contentPath.add(Paths.get(globalContext.getSwaggerLocation()).getParent());
        }
    }

    Optional<MarkupLanguage> extensionMarkupLanguageProperty = extensionsProperties.getMarkupLanguage(extensionId + "." + PROPERTY_MARKUP_LANGUAGE);
    if (extensionMarkupLanguageProperty.isPresent()) {
        extensionMarkupLanguage = extensionMarkupLanguageProperty.get();
    }
}
 

import io.github.swagger2markup.markup.builder.MarkupLanguage; //导入依赖的package包/类
@Override
public void init(Swagger2MarkupConverter.Context globalContext) {
    Swagger2MarkupProperties extensionsProperties = globalContext.getConfig().getExtensionsProperties();
    Optional<URI> snippetBaseUriProperty = extensionsProperties.getURI(extensionId + "." + PROPERTY_SNIPPET_BASE_URI);
    boolean withDefaultSnippets = extensionsProperties.getBoolean(extensionId + "." + PROPERTY_DEFAULT_SNIPPETS, true);
    if(withDefaultSnippets){
        withDefaultSnippets();
    }
    if (snippetBaseUriProperty.isPresent()) {
        snippetBaseUri = URIUtils.convertUriWithoutSchemeToFileScheme(snippetBaseUriProperty.get());
    }
    else{
        if (globalContext.getSwaggerLocation() == null) {
            if (logger.isWarnEnabled())
                logger.warn("Disable SpringRestDocsExtension > Can't set default snippetBaseUri from swaggerLocation. You have to explicitly configure the snippetBaseUri.");
        } else {
            snippetBaseUri = URIUtils.uriParent(globalContext.getSwaggerLocation());
        }
    }

    Optional<MarkupLanguage> extensionMarkupLanguageProperty = extensionsProperties.getMarkupLanguage(extensionId + "." + PROPERTY_MARKUP_LANGUAGE);
    if (extensionMarkupLanguageProperty.isPresent()) {
        extensionMarkupLanguage = extensionMarkupLanguageProperty.get();
    }
}
 

import io.github.swagger2markup.markup.builder.MarkupLanguage; //导入依赖的package包/类
@Test
public void shouldConvertIntoMarkdown() throws Exception {
    //given
    Map<String, String> config = new HashMap<>();
    config.put(Swagger2MarkupProperties.MARKUP_LANGUAGE, MarkupLanguage.MARKDOWN.toString());

    Swagger2MarkupMojo mojo = new Swagger2MarkupMojo();
    mojo.swaggerInput = new File(INPUT_DIR, SWAGGER_INPUT_FILE).getAbsoluteFile().getAbsolutePath();
    mojo.outputDir = new File(OUTPUT_DIR).getAbsoluteFile();
    mojo.config = config;

    //when
    mojo.execute();

    //then
    Iterable<String> outputFiles = recursivelyListFileNames(mojo.outputDir);
    assertThat(outputFiles).containsOnly("definitions.md", "overview.md", "paths.md", "security.md");
}
 

import io.github.swagger2markup.markup.builder.MarkupLanguage; //导入依赖的package包/类
@Override
public MarkupDocBuilder apply(MarkupDocBuilder markupDocBuilder, Parameters params) {
    DataFrame dataFrame = params.dataFrame;
    java.util.List<MarkupTableColumn> columnSpecs = dataFrame.getColumns().map(column -> {
                Integer widthRatio = Integer.valueOf(column.getMetaData().get(WIDTH_RATIO).getOrElse("0"));
                return new MarkupTableColumn(column.getId().getName())
                        .withWidthRatio(widthRatio)
                        .withHeaderColumn(Boolean.parseBoolean(column.getMetaData().get(HEADER_COLUMN).getOrElse("false")))
                        .withMarkupSpecifiers(MarkupLanguage.ASCIIDOC, ".^" + widthRatio + "a");
            }
    ).toJavaList();

    IndexedSeq<IndexedSeq<String>> columnValues = dataFrame.getColumns()
            .map(column -> ((StringColumn) column).getValues());

    java.util.List<java.util.List<String>> cells = Array.range(0, dataFrame.getRowCount())
            .map(rowNumber -> columnValues.map(values -> values.get(rowNumber)).toJavaList()).toJavaList();

    return markupDocBuilder.tableWithColumnSpecs(columnSpecs, cells);
}
 

import io.github.swagger2markup.markup.builder.MarkupLanguage; //导入依赖的package包/类
@Test
public void testWithAsciidocContentInTables() throws URISyntaxException {

    //Given
    Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore_with_adoc_content.yaml").toURI());
    Path outputDirectory = Paths.get("build/test/asciidoc/generated");
    FileUtils.deleteQuietly(outputDirectory.toFile());

    //When
    Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
            .withSwaggerMarkupLanguage(MarkupLanguage.ASCIIDOC)
            .build();

    Swagger2MarkupConverter.from(file).withConfig(config).build()
            .toFolder(outputDirectory);

    //Then
    String[] files = outputDirectory.toFile().list();
    assertThat(files).hasSize(4).containsAll(expectedFiles);

}
 

import io.github.swagger2markup.markup.builder.MarkupLanguage; //导入依赖的package包/类
public void swagger2MarkupConfigFromMap() throws IOException {
    Path localSwaggerFile = Paths.get("/path/to/swagger.yaml");

    // tag::swagger2MarkupConfigFromMap[]
    Map<String, String> configMap = new HashMap<>(); //<1>
    configMap.put(Swagger2MarkupProperties.MARKUP_LANGUAGE, MarkupLanguage.MARKDOWN.toString());
    configMap.put(Swagger2MarkupProperties.OUTPUT_LANGUAGE, Language.DE.toString());
    configMap.put(Swagger2MarkupProperties.PATHS_GROUPED_BY, GroupBy.TAGS.toString());

    Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder(configMap) //<2>
            .build();

    Swagger2MarkupConverter converter = Swagger2MarkupConverter.from(localSwaggerFile)
            .withConfig(config)
            .build();
    // end::swagger2MarkupConfigFromMap[]
}
 

import io.github.swagger2markup.markup.builder.MarkupLanguage; //导入依赖的package包/类
@Test
public void testToFolder() throws IOException, URISyntaxException {
    //Given
    Path file = Paths.get(MarkdownConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
    Path outputDirectory = Paths.get("build/test/markdown/to_folder");
    FileUtils.deleteQuietly(outputDirectory.toFile());

    //When
    Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
            .withMarkupLanguage(MarkupLanguage.MARKDOWN)
            .build();
    Swagger2MarkupConverter.from(file)
            .withConfig(config)
            .build()
            .toFolder(outputDirectory);

    //Then
    String[] files = outputDirectory.toFile().list();
    assertThat(files).hasSize(4).containsAll(expectedFiles);

    Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected/markdown/to_folder").toURI());
    DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testToFolder.html");
}
 

import io.github.swagger2markup.markup.builder.MarkupLanguage; //导入依赖的package包/类
@Test
public void testWithInterDocumentCrossReferences() throws IOException, URISyntaxException {
    //Given
    Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_petstore.yaml").toURI());
    Path outputDirectory = Paths.get("build/test/markdown/idxref");
    FileUtils.deleteQuietly(outputDirectory.toFile());

    //When
    Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
            .withMarkupLanguage(MarkupLanguage.MARKDOWN)
            .withInterDocumentCrossReferences()
            .build();

    Swagger2MarkupConverter.from(file).withConfig(config).build()
            .toFolder(outputDirectory);

    //Then
    String[] files = outputDirectory.toFile().list();
    assertThat(files).hasSize(4).containsAll(expectedFiles);

    Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected/markdown/idxref").toURI());
    DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testWithInterDocumentCrossReferences.html");
}
 

import io.github.swagger2markup.markup.builder.MarkupLanguage; //导入依赖的package包/类
@Test
public void testWithResponseHeaders() throws IOException, URISyntaxException {
    //Given
    Path file = Paths.get(AsciidocConverterTest.class.getResource("/yaml/swagger_response_headers.yaml").toURI());
    Path outputDirectory = Paths.get("build/test/markdown/response_headers");
    FileUtils.deleteQuietly(outputDirectory.toFile());

    //When
    Swagger2MarkupConfig config = new Swagger2MarkupConfigBuilder()
            .withMarkupLanguage(MarkupLanguage.MARKDOWN)
            .build();
    Swagger2MarkupConverter.from(file)
            .withConfig(config)
            .build()
            .toFolder(outputDirectory);

    //Then
    String[] files = outputDirectory.toFile().list();
    assertThat(files).hasSize(4).containsAll(expectedFiles);

    Path expectedFilesDirectory = Paths.get(AsciidocConverterTest.class.getResource("/expected/markdown/response_headers").toURI());
    DiffUtils.assertThatAllFilesAreEqual(expectedFilesDirectory, outputDirectory, "testWithResponseHeaders.html");
}
 

import io.github.swagger2markup.markup.builder.MarkupLanguage; //导入依赖的package包/类
@Parameters
public static Collection<Object[]> testParams() {
    return Arrays.asList(new Object[][]{
            {"/swagger.yaml", "yaml/asciidoc", MarkupLanguage.ASCIIDOC},
            {"/swagger.yaml", "yaml/markdown", MarkupLanguage.MARKDOWN},
            {"/swagger.yaml", "yaml/confluence", MarkupLanguage.CONFLUENCE_MARKUP},

            {"/swagger.json", "json/asciidoc", MarkupLanguage.ASCIIDOC},
            {"/swagger.json", "json/markdown", MarkupLanguage.MARKDOWN},
            {"/swagger.json", "json/confluence", MarkupLanguage.CONFLUENCE_MARKUP}
    });
}
 

import io.github.swagger2markup.markup.builder.MarkupLanguage; //导入依赖的package包/类
/**
 * Builds extension sections
 *
 * @param extensionMarkupLanguage the MarkupLanguage of the snippets content
 * @param contentPaths the path(s) where the content files reside
 * @param prefix      extension file prefix
 * @param levelOffset import markup level offset
 */
public void extensionsSection(MarkupLanguage extensionMarkupLanguage, List<Path> contentPaths, final String prefix, int levelOffset) {
    final Collection<String> filenameExtensions = globalContext.getConfig().getMarkupLanguage().getFileNameExtensions().stream()
            .map(fileExtension -> StringUtils.stripStart(fileExtension, "."))
            .collect(Collectors.toList());

    DirectoryStream.Filter<Path> filter = entry -> {
        String fileName = entry.getFileName().toString();
        return fileName.startsWith(prefix) && FilenameUtils.isExtension(fileName, filenameExtensions);
    };

    for (Path currentPath : contentPaths) {
        try (DirectoryStream<Path> extensionFiles = Files.newDirectoryStream(currentPath, filter)) {

            if (extensionFiles != null) {
                List<Path> extensions = Lists.newArrayList(extensionFiles);
                Collections.sort(extensions, Ordering.natural());

                for (Path extension : extensions) {
                    importContent(extension,
                            (reader) -> contentContext.getMarkupDocBuilder().importMarkup(reader, extensionMarkupLanguage, levelOffset));
                }
            }
        } catch (IOException e) {
            if (logger.isDebugEnabled())
                logger.debug("Failed to read extension files from directory {}", currentPath);
        }
    }
}
 

import io.github.swagger2markup.markup.builder.MarkupLanguage; //导入依赖的package包/类
/**
 * Instantiate extension
 * @param extensionId the unique ID of the extension
 * @param contentPath the base Path where the content is stored
 * @param extensionMarkupLanguage the MarkupLanguage of the extension content
 */
public DynamicOverviewDocumentExtension(String extensionId, List<Path> contentPath, MarkupLanguage extensionMarkupLanguage) {
    super();
    Validate.notNull(extensionMarkupLanguage);
    Validate.notNull(contentPath);
    if(StringUtils.isNoneBlank(extensionId)) {
        this.extensionId = extensionId;
    }
    this.contentPath = contentPath;
    this.extensionMarkupLanguage = extensionMarkupLanguage;
}