swagger导出接口文档

时间:2025-03-15 14:31:59
<plugin> <groupId>.swagger2markup</groupId> <artifactId>swagger2markup-maven-plugin</artifactId> <version>1.2.0</version> <configuration> <!--此处端口一定要是当前项目启动所用的端口--> <!--地址如图一--> <swaggerInput>http://172.0.0.1:8081/service-server/v2/api-docs?group=platform</swaggerInput> <!--生成多个文件--> <!--<outputDir>src/docs/asciidoc/generated</outputDir>--> <!--生成单个文件--> <outputFile>src/docs/asciidoc/api</outputFile> <config> <!-- 除了ASCIIDOC之外,还有MARKDOWN和CONFLUENCE_MARKUP可选,下面生成HTML和PDF的的插件依赖ASCIIDOC格式 --> <>MARKDOWN</> </config> </configuration> </plugin> <plugin> <groupId></groupId> <artifactId>asciidoctor-maven-plugin</artifactId> <version>1.5.3</version> <!-- Include Asciidoctor PDF for pdf generation --> <dependencies> <dependency> <groupId></groupId> <artifactId>asciidoctorj-pdf</artifactId> <version>1.5.0-alpha.10.1</version> </dependency> <dependency> <groupId></groupId> <artifactId>jruby-complete</artifactId> <version>1.7.21</version> </dependency> </dependencies> <!-- Configure generic document generation settings --> <configuration> <!--对应上面插件的outputdir--> <!--<sourceDirectory>src/docs/asciidoc/generated</sourceDirectory>--> <!--对应上面插件的outputfile--> <sourceDirectory>src/docs/asciidoc</sourceDirectory> <sourceDocumentName></sourceDocumentName> <sourceHighlighter>coderay</sourceHighlighter> <attributes> <toc>left</toc> </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>generate-resources</phase> <goals> <goal>process-asciidoc</goal> </goals> <configuration> <backend>html5</backend> <outputDirectory>src/docs/asciidoc/html</outputDirectory> </configuration> </execution> <!--pdf中文有乱码,目前不太好用--> <execution> <id>output-pdf</id> <phase>generate-resources</phase> <goals> <goal>process-asciidoc</goal> </goals> <configuration> <backend>pdf</backend> <outputDirectory>src/docs/asciidoc/pdf</outputDirectory> </configuration> </execution> </executions> </plugin>