1概要

この記事では、http://yaml.org/spec/1.2/specに基づいて構築された、ベンダーに依存しない、オープンスペック言語であるhttp://www.raml.org[RESTful APIモデリング言語(RAML)]を紹介します。 RESTful APIを記述するための.html[YAML 1.2]とJSON。

単純なJSONベースのAPIを定義する方法を説明しながら、基本的なRAML 1.0の構文とファイル構造について説明します。また、

includes

を使用してRAMLファイルのメンテナンスを簡略化する方法も示します。また、JSONスキーマを使用するレガシーAPIがある場合は、スキーマをRAMLに組み込む方法を説明します。

それから、オーサリングツール、ドキュメンテーションジェネレータなどを含む、RAMLへの旅をより充実させるためのツールをいくつか紹介します。

最後に、RAML仕様の現在の状態について説明します。