RAML

RAMLについて

チャットワークAPIは RAML (RESTful API Modeling Language) という仕様をもとにAPI設計の管理を行っています。APIゲートウェイとなるプログラムのインターフェイスやこのAPIドキュメントサイトは、ひとつのRAMLドキュメントをベースに自動生成されており、差分がないように管理されています。

RAMLはRESTful APIを設計するための定義をYAMLベースでまとめた仕様となっているため、プログラム的にAPI設計を簡易に読み出すことができ、またRAMLに対応した各種ツールを利用することができます。(RAML関連のプロジェクト)

ツールの例:RAML API Designer

チャットワークAPIのRAML

チャットワークAPIのRAMLデータをGitHubのリポジトリにて公開しています。仕様変更時は随時更新していきますので、変更箇所の詳細を確認する場合にご利用ください。