「東京メトロオープンデータ活用コンテスト」②APIの仕様設計を理解し、ドキュメント化する - Qiita

成果物：apiary.ioによる、APIドキュメント とりあえず見て貰えるとイメージつかみやすいです↑ あらすじ 100万円欲しいのでAPIを利用したアプリ開発を学ぶ絶好の機会なので、東京メトロオープンデータ活用コンテストに挑戦しようとしている。 前回、とりあえずざっと触ってみてAPIのイメージは掴んだ 今回は、公式ドキュメントと実際のレスポンスを咀嚼して、仕様設計を汎用ドキュメント化しつつ理解していくことを目的とする せっかくドキュメント化するからには、汎用性と実用性が高いフォーマットとしたい（オレオレにはしたくない） 成果物 API Blueprintで記述されたテキストをApiary.ioでホスティングし、以下を作った TokyoMetroOpendataAPI · Apiary github上のソース（markdownプレビュー版） やってみてわかった、ApiaryによるAPIドキ

[ryskosn]

各言語のサンプルもある

[tuki0918]

“apiary.io”

[suVene]

「東京メトロオープンデータ活用コンテスト」②APIの仕様設計を理解し、ドキュメント化する. via suvene@githubのストックした投稿 - Qiita.

[imototakeshi]

つかいたい。

[masa-wo]

APIのドキュメント化 すばら。

[h5y1m141]

こんなのあるのか

[poppun1940]

オレオレAPIドキュメントと比べると、圧倒的なメリットがあるように感じる API Blueprintとは何なのか 引用: API Blueprint - API Documentation with powerful tooling WebAPI専用のmarkdown風言語。機械が読める構造を維持しつつ、人にも易しい