APIの仕様をMarkdownで定義する - HDE BLOG
おはこんばんちは!! 尾藤 a.k.a. BTO です。 Web APIの仕様の定義ってみなさんどうされているでしょうか。 人によって書き方がバラバラだったり、定義に過不足があったりしてないでしょうか。 Web APIのインターフェースで定義する内容は、ほとんど決まってます。 もっと形式的な書き方できないだろうかと探してみたら、やはり同じ事を考えている人がいて、API Blueprintというのを見つけました。 API Blueprint - API Documentation with powerful tooling API Blueprintを使うとMarkdownでAPIの定義ができます。 できること APIの記述フォーマットが決まっていますので、どこで何が定義されているかが分かります。 ですので、機械的に処理する事ができるようになります。 具体的には、 APIドキュメントの生成
Apiary - r7kamura per second
API(とそれに携わる開発者)の規模が拡大してくると、ドキュメントの整備や、仕様と実装の一貫性の維持、 クライアントとの知識の共有など、考慮すべき問題が沢山出てくる。 これらの問題に対する現実的な解決策を探るため、 ApiaryというAPI開発支援用のサービスを簡単に俯瞰することにした。 ここでは紹介しないが、他に RAML、 JSON Schema、 Swagger、 WADL、 Autodoc などが関連するものとして挙げられる。 Apiary http://apiary.io/ Apiaryは、API Blueprintと呼ばれる言語でAPIのインターフェース仕様書を記述する、という開発方法を提唱している。 API BlueprintはMarkdownを拡張した言語で、特殊な記述を用いて幾つかのメタ情報を付与出来る形になっている。 Markdownを採用することで人間にとって読み書き
APIドキュメントを生成するためのMarkdown拡張API BluePrintとその周辺のライブラリ - Qiita
API Blueprint(以下Blueprint) は MarkdownファイルからAPIドキュメントやサンプルデータになる JSONを生成する仕様。 一旦決められたフォーマットのJSONに吐き出すので、 それを中心に入出力のライブラリが色々あったりする。 Blueprintのパーサー MarkdownからJSONを出力するために Snow Crashというライブラリを利用する。 後に書くものは大体このSow Crashを利用するので詳細は省略。 BlueprintからAPIドキュメントHTMLを生成する Blueprintを上手く扱うために、 色々なライブラリが用意されている。 aglioはBlueprintから表示用htmlを用意してくれるライブラリ。 # output.htmlにファイル出力 $ aglio -i input.md -o output.html # デフォルトの h
API Blueprint | API Blueprint
API Blueprint. A powerful high-level API description language for web APIs. API Blueprint is simple and accessible to everybody involved in the API lifecycle. Its syntax is concise yet expressive. With API Blueprint you can quickly design and prototype APIs to be created or document and test already deployed mission-critical APIs. Tutorial Tools section Focused on Collaboration API Blueprint is bu
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
http://www.mikestowe.com/2014/07/raml-vs-swagger-vs-api-blueprint.php
GitHub - localmed/api-mock: Creates a mock server based on an API Blueprint
GitHub - danielgtaylor/aglio: An API Blueprint renderer with theme support that outputs static HTML
