做外贸网站哪里好,建设企业网站服务器,做网站互联互通,牟平做网站Raml实践简介#xff1a;RAML的全称是RESTful API Modeling Language#xff0c;这是一种用来描述基于Restful架构的API(设计API)的语言。它的语法规范是基于YAML的新规范#xff0c;因此机器与人类都能够轻易地理解其中的内容。一、工具安装一、API Workbench(客户端工具-推…Raml实践简介RAML的全称是RESTful API Modeling Language这是一种用来描述基于Restful架构的API(设计API)的语言。它的语法规范是基于YAML的新规范因此机器与人类都能够轻易地理解其中的内容。一、工具安装一、API Workbench(客户端工具-推荐)介绍API Workbench是一个丰富的全功能集成开发环境(IDE)用于设计构建测试记录和共享RESTful HTTP API。它支持RAML 0.8和最近启动的RAML 1.0。RAML使得易于管理从设计到共享的整个API生命周期。安装1.安装Atom2.在Setting-Install栏目搜索并安装api-workbench3.在Setting-Packages中可以看到已安装的api-workbench二、API Designer(Web工具)介绍由MuleSoft开发的基于RAML的Web工具专门用于创建和分享API标准的web编辑器。它能提示在什么地方应该使用什么元素以及指出创建的RAML文档中的错误。安装1.安装Nodejs2.通过npm安装模块npm install -g api-designer3.运行命令api-designer三、raml2html介绍把.raml转换成html格式便于查看安装1.安装nodejs2.通过npm安装模块npm install -g raml2html3.运行命令raml2html api.raml api.html4.预览图二、Raml语法根节点元素汇总1.documentation可选文档节点包括作为API的用户指南和参考文档的各种文档。这些文件可以阐明API如何工作或提供技术和业务环境。文档节点的值是一个或多个文档的序列。每个文档都是一个映射必须在下面的表中有两个键值对名称描述title文件标题。它的值必须是非空字符串。content文件内容。它的值必须是一个非空字符串可以使用Markdown格式。举例#%RAML 1.0title: ZEncoder APIbaseUri: https://app.zencoder.com/apidocumentation:- title: Homecontent: |Welcome to the _Zencoder API_ Documentation. The _Zencoder API_allows you to connect your application to our encoding serviceand encode videos without going through the web interface. Youmay also benefit from one of our[integration libraries](https://app.zencoder.com/docs/faq/basics/libraries)for different languages.- title: Legalcontent: kkkkkkk效果12.Base URI and Base URI Parameters可选的baseuri节点指定一个URI作为标识符的API作为一个整体并可用于指定URL的API服务(服务终端)构成它的每个资源的URL的基础。该baseuri节点的值是一个字符串必须符合规范或模板rfc2396 URI的URI。距离#%RAML 1.0title: Amazon S3 REST APIversion: 1baseUri: https://{bucketName}.s3.amazonaws.combaseUriParameters:bucketName:description: The name of the bucket效果3.Protocols可选协议节点指定API支持的协议。如果协议节点没有明确规定在baseuri节点包含一个或多个协议使用如果协议是显式指定的节点节点规范凌驾于任何协议包括在baseuri节点。该协议的节点必须是一个非空的字符串数组值的HTTP或HTTPS并是不区分大小写。下面是一个例子一个API端点接收HTTP和HTTPS请求。举例#%RAML 1.0title: Salesforce Chatter REST APIversion: v28.0protocols: [ HTTP, HTTPS ]baseUri: https://na1.salesforce.com/services/data/{version}/chatter4.Default Media Types
