raml2html 安装,Raml实践
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.安裝Atom
2.在Setting->Install欄目，搜索并安裝api-workbench
3.在Setting->Packages中可以看到已安裝的api-workbench
二、API Designer(Web工具)
介紹：
由MuleSoft開發的基于RAML的Web工具，專門用于創建和分享API標準的web編輯器。
它能提示在什么地方應該使用什么元素以及指出創建的RAML文檔中的錯誤。
安裝：
1.安裝Nodejs
2.通過npm安裝模塊
npm install -g api-designer
3.運行命令
api-designer
三、raml2html
介紹：
把.raml轉換成html格式便于查看
安裝：
1.安裝nodejs
2.通過npm安裝模塊
npm install -g raml2html
3.運行命令
raml2html api.raml > api.html
4.預覽圖
二、Raml語法
根節點元素匯總
1.documentation
可選文檔節點包括作為API的用戶指南和參考文檔的各種文檔。這些文件可以闡明API如何工作或提供技術和業務環境。
文檔節點的值是一個或多個文檔的序列。每個文檔都是一個映射，必須在下面的表中有兩個鍵值對：
名稱
描述
title
文件標題。它的值必須是非空字符串。
content
文件內容。它的值必須是一個非空字符串，可以使用Markdown格式。
舉例：
#%RAML 1.0
title: ZEncoder API
baseUri: https://app.zencoder.com/api
documentation:
- title: Home
content: |
Welcome to the _Zencoder API_ Documentation. The _Zencoder API_
allows you to connect your application to our encoding service
and encode videos without going through the web interface. You
may also benefit from one of our
[integration libraries](https://app.zencoder.com/docs/faq/basics/libraries)
for different languages.
- title: Legal
content: kkkkkkk
效果：
1
2.Base URI and Base URI Parameters
可選的baseuri節點指定一個URI作為標識符的API作為一個整體，并可用于指定URL的API服務(服務終端)，構成它的每個資源的URL的基礎。該baseuri節點的值是一個字符串，必須符合規范或模板rfc2396 URI的URI。
距離：
#%RAML 1.0
title: Amazon S3 REST API
version: 1
baseUri: https://{bucketName}.s3.amazonaws.com
baseUriParameters:
bucketName:
description: The name of the bucket
效果：
3.Protocols
可選協議節點指定API支持的協議。如果協議節點沒有明確規定，在baseuri節點包含一個或多個協議使用；如果協議是顯式指定的節點，節點規范凌駕于任何協議包括在baseuri節點。該協議的節點必須是一個非空的字符串數組，值的HTTP或HTTPS，并是不區分大小寫。
下面是一個例子，一個API端點接收HTTP和HTTPS請求。
舉例：
#%RAML 1.0
title: Salesforce Chatter REST API
version: v28.0
protocols: [ HTTP, HTTPS ]
baseUri: https://na1.salesforce.com/services/data/{version}/chatter
4.Default Media Types
總結
以上是生活随笔為你收集整理的raml2html 安装,Raml实践的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： HTML Help Workshop制作
- 下一篇： 数据转换之 Number