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

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

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

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

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

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

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 ... 続きを読む