書いて見たらほぼこの記事と同じなったので、一旦この記事を見るで問題ない
http://qiita.com/takizawa-hiroki/items/4613a7520a6f6c6e5cd2
RAMLの0.8から1.0への破壊的変更だけはちゃんと見ておいた方がいい。
チュートリアル
http://raml.org/developers/raml-100-tutorial
http://raml.org/developers/raml-200-tutorial
1.0の仕様
ネットの情報はだいたい0.8だが、差分は下記ドキュメントでだいたい埋まる
実行環境
初めからブラウザベースの補完なども利く高機能なエディターが用意されている
$ yarn global add api-designer
$ api-designer
swaggerにもswagger-editorというものがあるが、仕様でもErrorを吐くのでイライラして作業でいない。
HTML Export
書いたら吐き出す。そのままramlファイルとしてはapi-designerからExportできる。
吐き出されたramlをhtmlに変換する。
$ yarn global add raml2html
$ raml2html -i api.raml -o api.raml
or
$ raml2html api.raml > api.raml