RAML文档生成器raml2html详解

蔚落 2022-06-13 04:20 172阅读 0赞

raml2html是一款从RAML到HTML的文档生成器，JavaScript语言编写。  
raml2html默认支持Node.js，支持默认或定制theme。

1. 版本  
raml2html 3.x支持RAML 0.8

raml2html 4支持RAML 1.0

2. 安装

npm i -g raml2html

安装Markdown主题

npm i -g raml2html-markdown-theme

3. 作为命令行工具使用

raml2html --help
    raml2html examples\helloworld.raml > helloworld.html
    raml2html --theme raml2html-markdown-theme examples\helloworld.raml > example.html
    raml2html --template my-custom-template.nunjucks -i examples\helloworld.raml -o example.html

生成的页面如下：

![Center][]

4. 作为JS类库使用

const raml2html = require('raml2html');
    const configWithDefaultTheme = raml2html.getConfigForTheme();
    const configForDifferentTheme = raml2html.getConfigForTheme('raml2html-markdown-theme');
    const configWithCustomTemplate = raml2html.getConfigForTemplate('~/path/to/my-custom-template.nunjucks');
    raml2html.render(source, configForDifferentTheme).then(function(result) {
        // Save the result to a file or do something else with the result
        }, function(error) {
            // Output error
        });

参考链接：

https://github.com/raml2html/raml2html

[Center]: /images/20220613/a6f1eabc61af45f5a7e6276f63ce13ff.png

发表评论取消回复

表情：

评论列表（有 0 条评论，172人围观）

还没有评论，来说两句吧...

相关阅读

相关 RAML

RAML RAML - (RESTful API Modeling Language 即RESTful API建模语言) 易于阅读API 易于设计API

水深无声/ 2022年08月21日 06:47/ 0 赞/ 159 阅读

相关 RAML文档生成器raml2html详解

raml2html是一款从RAML到HTML的文档生成器，JavaScript语言编写。 raml2html默认支持Node.js，支持默认或定制theme。 1. 版本

蔚落/ 2022年06月13日 04:20/ 0 赞/ 173 阅读

相关 RAML概述

RAML(RESTful API Modeling Language)是一个采用YAML格式定义的API建模语言。 2016.7发布最新版本1.0.1 RAML在

淩亂°似流年/ 2022年06月13日 02:26/ 0 赞/ 394 阅读

相关 RAML for JAX-RS的raml-to-jaxrs子项目简介

RAML for JAX-RS是Mulesoft提供的RAML工具之一，能够从RAML文件生成Java+JAX-RS的代码，或者反之。最新版本是2017.7发布的2.1.0。

你的名字/ 2022年06月12日 03:48/ 0 赞/ 169 阅读

相关 Spring MVC - RAML Spec Synchroniser简介

1. Spring MVC - RAML Spec Synchroniser是一个工具，用以在Spring MVC应用和RAML文件定义之间进行同步。即Spring MVC应用

雨点打透心脏的1/2处/ 2022年06月12日 01:45/ 0 赞/ 203 阅读

相关 RAML文件的Java解析器raml-java-parser概述

raml-java-parser是RAML社区提供的开源Java解析器。之前还有一个RAML 0.8的Java解析器，现在命名为raml-java-parser-2，已经过时了

╰半橙微兮°/ 2022年06月10日 10:13/ 0 赞/ 187 阅读

相关 RAML 1.0中引用JSON Schema的方法详解

在RAML 1.0中，不再推荐使用Schema，但是为了保持与RAML 0.8的兼容，所以仍然保留了Schema相关的关键字。在RAML 1.0中，放弃了RAML 0.8的

比眉伴天荒/ 2022年06月09日 14:20/ 0 赞/ 159 阅读

相关 RAML 学习笔记

RAML 学习笔记 RAML,Swagger和API Blueprint区别 Swagger 优势在于对从现有的程序中自动生成接口，无需完全手写文档； RAML

朱雀/ 2022年05月09日 06:58/ 0 赞/ 156 阅读

相关基于RAML的API接口文档管理

基于RAML的API接口文档管理文章目录基于RAML的API接口文档管理什么是RAML 怎么使用RAML

逃离我推掉我的手/ 2022年01月31日 04:41/ 0 赞/ 459 阅读

相关使用RAML描述API文档信息的一些用法整理

RAML是Restful API Modeling Language的缩写，是用来描述API信息的文档。创建一个.raml后缀的文件，用Atom打开。基本用法

女爷i/ 2021年11月02日 13:00/ 0 赞/ 561 阅读