美文网首页
2018-12-04swaggermarkup 生成静态文件

2018-12-04swaggermarkup 生成静态文件

作者: Suncoffee_psw | 来源:发表于2018-12-04 10:46 被阅读0次

1、创建目录文件

在项目中创建以下目录文件:
src/docs/asciidoc/generated,如下图所示;


image.png
  • 在asciidoc目录下创建index.adoc文件,文件内容为:
    include::{generated}/overview.adoc[]
    include::{generated}/paths.adoc[]
    include::{generated}/security.adoc[]
    include::{generated}/definitions.adoc[]

2、修改pom文件,引入相关的依赖包:

<dependency>
<groupId>io.github.swagger2markup</groupId>
<artifactId>swagger2markup</artifactId>
<version>1.3.3</version>
</dependency>
<pluginRepositories>
<pluginRepository>
<id>jcenter-snapshots</id>
<name>jcenter</name>
<url>http://oss.jfrog.org/artifactory/oss-snapshot-local/</url>
</pluginRepository>
<pluginRepository>
<snapshots>
<enabled>false</enabled>
</snapshots>
<id>jcenter-releases</id>
<name>jcenter</name>
<url>http://jcenter.bintray.com</url>
</pluginRepository>
</pluginRepositories>

<plugin>
<groupId>io.github.swagger2markup</groupId>
<artifactId>swagger2markup-maven-plugin</artifactId>
<version>1.3.3</version>
<configuration>
<swaggerInput>http://localhost:9004/v2/api-docs</swaggerInput>
<outputDir>src/docs/asciidoc/generated</outputDir>
<config>
<swagger2markup.markupLanguage>ASCIIDOC</swagger2markup.markupLanguage>
</config>
</configuration>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>1.5.6</version>
<configuration>

<sourceDirectory>src/docs/asciidoc/generated</sourceDirectory>

<outputDirectory>src/docs/asciidoc/html</outputDirectory>
<backend>html</backend>
<sourceHighlighter>coderay</sourceHighlighter>
<attributes>

<toc>left</toc>



<sectnums>true</sectnums>
</attributes>
</configuration>
</plugin>
<repositories>
<repository>
<id>jcentral</id>
<name>bintray</name>
<url>http://jcenter.bintray.com</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>

  • 注意:swaggerInput 中的内容为实际项目的URL,如下图所示:


    image.png

3、文件生成

  • 确认在maven插件中是否有以下两个插件,如图所示:


    image.png
  • 执行顺序:
    先启动相应的服务。
    执行:swagger2markup-maven-plugin,执行完成后会在生成以下文件:


    image.png

    执行:process-asiidoc,生成相应的html文件:


    image.png

4、HTML转为PDF

目前不进行插件转化为PDF,通过打印的页面的方式另存为pdf文件:
image.png

相关文章

  • 2018-12-04swaggermarkup 生成静态文件

    1、创建目录文件 在项目中创建以下目录文件:src/docs/asciidoc/generated,如下图所示; ...

  • protobufjs typescript 静态模块使用方式

    message.proto 生成js静态模块文件 生成ts声明文件 修改生成的js静态模块文件 使用

  • 在github中使用Hexo编辑文档(一)

    原理: 文档以 MarkDown 文件编写 使用 hexo 将 MarkDown 文件生成成静态文件 将静态文件发...

  • 怎么快速搭建一个美观实用的博客?

    博客使用静态网站生成技术生成,静态网站生成是指静态生成网站的过程,即生成HTML文件,例如,在本地计算机中,然后将...

  • 链接静态库生成可执行文件

    链接静态库.a生成可执行文件 操作文件夹:链接静态库.a文件 在生成test.o文件时,需要有TestExampl...

  • 全局静态画和动态静态化

    一:全局静态化全局静态化是将一个页面生成静态文件存在某个文件中常用的方法有:1.当前时间与生成的静态文件时间差2....

  • Flask第二天

    静态文件 给静态文件生成 URL ,使用特殊的 'static' 端点名:url_for('static', fi...

  • Django 生成静态页面

    当用户访问时,如果判断没有静态页面就自动生成静态页面,然后返回静态文件,当文件存在的时候就不再次生成。也可以用一个...

  • 静态网站 介绍

    什么是静态网站生成器 静态网站生成器是使用一系列配置、模板以及数据,生成静态 HTML 文件及相关资源的工具 由于...

  • 场景实践篇

    静态资源web服务 静态资源 定义 非服务器动态生成的文件 静态资源服务场景-CDN 文件读取配置 sendfil...

网友评论

      本文标题:2018-12-04swaggermarkup 生成静态文件

      本文链接:https://www.haomeiwen.com/subject/wvxmcqtx.html