RESTful APIの設計、開発、ドキュメント管理を手助けする「RAML」とは

2024/06/14 113 users API ドキュメント RESTful API アプローチ 整備

APIの開発は複雑でコストがかかる可能性があり、頻繁に更新されることからドキュメントを整備するのも難しい。APIの設計、開発、ドキュメントの整備、管理にまつわる課題と効率さの問題に対処するアプローチが、RESTful API Modeling Language（RAML：RESTful APIモデリング言語）だ。 RAMLコードを使えば、開発者はAPI... 続きを読む

JSON Schema 中心設計 - FlowType から RAML まで - - Qiita

2017/09/19 90 users Flowtype Qiita バリデーション API 恩恵

はじめに Web サービスの運用を続けていくと，依存関係が徐々に複雑になっていきます．そしてメンテナンスするものが増えた結果，それらが相互に乖離していく，といったことが起こりがちです． そこで今回は，JSON Schema のみをメンテナンスしていくことで，動的チェック (バリデーション)，静的チェック (FlowType)，API ドキュメント生成，スタブ作成といった様々な恩恵を享受し，品質と保... 続きを読む

僕が考えた最強のAPIドキュメント生成 - 銀の人のメモ帳

2016/02/16 320 users 最強 メモ帳 request Rails JSON

2016 - 02 - 16 僕が考えた最強のAPIドキュメント生成 TL; DR ドキュメント生成には kevinrenskers/raml2html を使った ドキュメントは RAML - RESTful API modeling language で書いた RAMLには JSON Schema と JSON を記載できる API で返ってくる JSON は Rails アプリのrequest... 続きを読む

Apiary - r7kamura per second

2014/02/13 88 users Apiary autodoc Swagger API 実装

API(とそれに携わる開発者)の規模が拡大してくると、ドキュメントの整備や、仕様と実装の一貫性の維持、 クライアントとの知識の共有など、考慮すべき問題が沢山出てくる。 これらの問題に対する現実的な解決策を探るため、 ApiaryというAPI開発支援用のサービスを簡単に俯瞰することにした。 ここでは紹介しないが、他に RAML、 JSON Schema、 Swagger、 WADL、 Autodoc... 続きを読む

RAML - RESTful API modeling language

2013/10/02 224 users reuse RESTful API And

RESTful API Modeling Language RESTful API Modeling Language (RAML) is a simple and succinct way of describing practically-RESTful APIs. It encourages reuse, enables discovery and pattern-sharing, and ... 続きを読む