RAML的学习之路(二)

最新推荐文章于 2024-09-06 21:35:54 发布
最新推荐文章于 2024-09-06 21:35:54 发布
阅读量1.7k 收藏 1
点赞数 1
文章标签： api html 文档 raml restful
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/vduoluo/article/details/55014693
版权

RAML文档展示

raml的文档展示有两个较流行的工具
- API Console
- RAML to HTML

两个均试用过,RAML to HTML的展示是比较人性化的
以下采用RAML to HTML工具进行试验

使用方法

npm i -g raml2html
raml2html api.raml > api.html

生成html文件

打开api.html文件后如图:

微信截图_20170212094241.png

每一项是可以展开的,如图:

微信截图_20170212094254.png

单击GET或POST方法,可以打开详情,如图:

微信截图_20170212094322.png

上图展示了api接口的请求参数,下面展示下返回数据详情:

微信截图_20170212094345.png

未完待续……

奔跑的小草
关注
raml-spec：RAML规格
02-21
RESTful API建模语言（RAML）规范 RAML规范的当前版本为1.0，您可以在找到它。 RAML是一种用于定义基于HTTP的API的语言，该API体现了大多数或所有代表状态传输（REST）的原理。 RAML规范（本文档）定义了的应用...
DSP CMD文件配置详解
xinanzhung的专栏
12-18 4568
1 CMD文件的分配方法 TI公司新的汇编器和链接器创建的目标文件采用一种COFF(通用目标文件格式)，该目标文件格式更利于模块化编程，为管理代码段和目标系统存储器提供了强有力和灵活的编程方法。用户可以通过编写链接命令文件(.cmd文件)将链接信息放在一个文件中，以便在多次使用同样的链接信息时调用。在命令文件中使用两个十分有用的伪指令MEMORY和SECTIONS，来指定实际应用中的存储器结
RAML规范1.0(译文)
Lucifer ZHAO
06-24 1070
RAML: RESTful API Modeling Language即RESTful API建模语言，是对RESTful API的一种简单直接的描述。它是一种让人们易于阅读且能让机器对特定文档可以解析的语言。RAML是基于YAML，符合1.2版本规范。通过RAML定义，因为机器可以解析，所以RAML规范提供了一些机制，可以定义实际的RESTful API，创建client / server源代码，以及为用户生成API文档。..............................
RAML学习
最新发布
pumpkin84514的博客
09-06 730
RAML（RESTful API Modeling Language）是一种基于 YAML 的语言，用于定义 RESTful API。它的主要目的是在编写代码之前定义 API 的结构和行为，从而简化设计、开发和维护 API 的过程。通过 RAML，开发者和设计师可以明确 API 的各个方面，包括资源、方法、请求和响应格式。RAML 是一种基于 YAML 的 API 设计语言，可以帮助团队在开发 API 前就明确其结构和行为。
RAML的学习之路(一)
vduoluo的博客
02-13 6295
RAML是什么呢?下面这段话摘自于网络 RAML的全称是RESTful API建模语言，这是一种基于YAML格式的新规范，因此机器与人类都能够轻易地理解其中的内容。但RAML的目的不仅仅在于创建更易于理解的规范（你可以将这一工作指派给文档团队，他们会做得更好）而已。RAML的设计者Uri Sarid希望使用者能够打破固有的思维，在开始编写代码之前以一种全新的方式对API进行建模。 它的官网是:
RAML规范1.0(英文版)
Lucifer ZHAO
06-22 590
This specification describes the RESTful API Modeling Language (RAML). RAML is a human- and machine-readable language for the definition of a RESTful application programming interface (API). RAML is designed to improve the specification of the API by provi
RAML文档生成器raml2html详解
成长的足迹
06-27 4558
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 raml2ht
RAML规范解读
12-31
RAML，即RESTful API Modeling Language，是一种专门用于描述RESTful API的建模语言。它旨在提供一种简单直接的方式来定义RESTful服务的结构和行为，使得API的设计更加标准化和易于理解。RAML基于YAML（YAML Ain't ...
soapui-raml-plugin
05-31
SoapUI RAML 插件 此存储库包含 ReadyAPI 的 RAML 插件的源代码。 使用这个插件来： 将 RAML 文件导入 ReadyAPI 以测试您的 REST API 为正在导入的 RAML 文件生成 REST 虚拟服务 从 RAML 文件更新 ReadyAPI 中的...
raml2html:RAML到HTML文档生成器
05-08
一个简单的RAML到HTML文档生成器，为Node.js编写，具有主题支持。RAML版本支持raml2html 4和更高版本仅支持RAML 1.0文件。 请坚持使用raml2html 3.x以获得RAML 0.8支持。安装npm i -g raml2html主题raml2html带有...
webservice-consumer-raml
07-16
## 从前端 RAML API 使用后端 SOAP API 此示例应用程序用于从 CloudHub SOAP 服务使用两个 SOAP API 先决条件Anypoint Studio 5.1.2 JavaSE-1.7.0_71 Apache Maven 3.1.1 Mule Runtime 3.6.1 EE 注意：不要使用 ...
MuleSoft开源用于设计RESTful APIs的工具RAML Tools
啊啊啊啊2
11-09 555
近日，MuleSoft发布了3款基于RAML的用于设计、评估和测试RESTful APIs的工具。\u0026#xD;\nRAML来源于RESTful API建模语言，它是一种让人们易于阅读并且能让机器对特定的文档能解析的语言。RAML是基于YAML，符合1.2版本规范，能帮助设计RESTful　API和鼓励对API的发掘和重用，依靠标准和最佳实践从而编写更高质量的API。\u0026#xD;\n...
RAML 学习笔记
zhaozhen的博客
10-03 5550
RAML 学习笔记 RAML,Swagger和API Blueprint区别 Swagger 优势在于对从现有的程序中自动生成接口，无需完全手写文档； RAML 的优势是文档编写清晰方便，适合于没有现成接口，而需要全新规划； Blueprint 的优点是 markdown 语法。因为目前手头的接口也是从 0 开始，也需要系统性的规划一下，因此选择 RAML 兼顾编写和规划 编辑器选择 VS cod...
RAML概述
成长的足迹
06-23 4951
RAML(RESTful API Modeling Language)是一个采用YAML格式定义的API建模语言。 2017.6发布最新版本1.0 RAML在Github上有一组项目，组成如下： raml-spec RAML规范 raml-examples RAML特性示例，RAML规范的组成部分 raml-definition-system RAML 1.0定
raml转换为html,js,markdown
Walter`s blog
12-12 771
通过raml将接口设计完成后，我们需要提供简洁可读的直观视图和说明文档。 这里我们通过node.js来实现转换Raml2html官方地址raml版本支持raml2html 4和更高的版本仅支持raml 1.0语法转换，对于raml 0.8语法，需要使用raml2html的3.x版本安装npm i -g raml2html使用raml2html –help raml2html example.ra
RAML基本语法
Walter`s blog
11-28 3018
人类可读的raml语法开始设计时，首先创建一个包含以下内容的RAML文件： #%RAML 0.8 title: This is My API baseUri: http://api.domain.com version: 1 在以上代码中，我们首先声明这是一个RAML规范，它对应RAML 0.8，并声明API的标题、基本URI、以及这个API的版本号。 在RAML中声明资源非常简单，只需使用/r
raml 的使用
fang_qiming的博客
02-26 2980
场景.使用raml构建接口文档1.安装能够将raml 转化为 html 文件的 raml2html工具 安装步骤如下npm i -g raml2html2.将编辑好的raml文件生成html文件以便查阅raml2html test.v1.raml > test.v1.html3.下载mock服务以便能够通过http服务访问接口    如果在下载过程中出错诸如（rollbackFailedOp...
raml php,RAML的学习之路(一)
weixin_42433737的博客
04-01 181
RAML是什么呢?下面这段话摘自于网络RAML的全称是RESTful API建模语言，这是一种基于YAML格式的新规范，因此机器与人类都能够轻易地理解其中的内容。但RAML的目的不仅仅在于创建更易于理解的规范(你可以将这一工作指派给文档团队，他们会做得更好)而已。RAML的设计者Uri Sarid希望使用者能够打破固有的思维，在开始编写代码之前以一种全新的方式对API进行建模。它的官网是:虽然目前...
html 文档生成器,RAML文档生成器raml2html详解
weixin_32121931的博客
06-03 282
raml2html是一款从RAML到HTML的文档生成器，JavaScript语言编写。raml2html默认支持Node.js，支持默认或定制theme。1. 版本raml2html 3.x支持RAML 0.8raml2html 4支持RAML 1.02. 安装npm i -g raml2html安装Markdown主题npm i -g raml2html-markdown-theme3. 作为...
RAML：RESTful API建模语言详解
"RAML规范解读" RAML（RESTful API Modeling Language）是用于建模RESTful API的一种语言，它的核心目标是使API的设计过程更加简单、直观且可读性强，同时也能被机器解析，以支持自动化工具的使用。RAML基于YAML...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值