如何生成这个 Spring-boot API 文档示例?

问题描述 投票:0回答:1

我正在尝试追踪一个已经离开公司的开发人员是如何生成一些 Java Spring-boot API 的。该文件如下所示:

enter image description here

我们有招摇,但这看起来不像由此产生的任何东西。绝对看起来不像javadoc。有什么想法吗?

感谢 João Dias 的回答,我在 pom.xml 中找到了这个:

<!-- Run the generated asciidoc through Asciidoctor to generate other 
        documentation types, such as PDFs or HTML5 -->
    <plugin>
        <groupId>org.asciidoctor</groupId>
        <artifactId>asciidoctor-maven-plugin</artifactId>
        <version>1.5.6</version>
        <!-- Include Asciidoctor PDF for pdf generation -->
        <dependencies>
            <dependency>
                <groupId>org.asciidoctor</groupId>
                <artifactId>asciidoctorj-pdf</artifactId>
                <version>1.5.0-alpha.16</version>
            </dependency>
            <dependency>
                <groupId>org.jruby</groupId>
                <artifactId>jruby-complete</artifactId>
                <version>1.7.21</version>
            </dependency>
        </dependencies>
        <!-- Configure generic document generation settings -->
        <configuration>
            <sourceDirectory>${asciidoctor.input.directory}</sourceDirectory>
            <sourceDocumentName>index.adoc</sourceDocumentName>
            <attributes>
                <doctype>book</doctype>
                <toc>left</toc>
                <toclevels>3</toclevels>
                <numbered></numbered>
                <hardbreaks></hardbreaks>
                <sectlinks></sectlinks>
                <sectanchors></sectanchors>
                <generated>${generated.asciidoc.directory}</generated>
            </attributes>
        </configuration>
        <!-- Since each execution can only handle one backend, run separate executions 
            for each desired output type -->
        <executions>
            <execution>
                <id>output-html</id>
                <phase>test</phase>
                <goals>
                    <goal>process-asciidoc</goal>
                </goals>
                <configuration>
                    <backend>html5</backend>
                    <outputDirectory>${asciidoctor.html.output.directory}</outputDirectory>
                </configuration>
            </execution>
        </executions>
    </plugin>
</plugins>
<pluginManagement>
spring-boot swagger documentation
1个回答
2
投票

如果我没记错的话,这是 Spring REST 文档。了解更多详情:

© www.soinside.com 2019 - 2024. All rights reserved.