タグ

ブックマーク / kray.jp (1)

  • Apiary でモダンでインタラクティブなAPIドキュメントを作る

    はじめに ようやく待望の冬!なんですが、先日20℃を超える気温を記録しましたね。季節外れの熱気に驚きました。それに今シーズンは暖冬になりそうということで雪不足も懸念されます。まだスキーの予定も立てられてないんですけど。 さて、最近のWebサービスではAPIを公開することも珍しくないと思います。参考になるRESTfulなAPI設計もよく見られるようになりました。ただ、そのなかで分かりやすい資料、APIの実行を試しやすい環境を提供できているケースはそう多くないように思います。開発者の立場でいえば、ドキュメント整備にそこまで気を遣う余裕なんてないことが大半かもしれません。一方で、APIを利用する側からすれば最初に目を通すのはドキュメントですから、その出来不出来はAPIに対する評価にもつながります。 そういうわけで、今回はWeb APIのドキュメント環境である Apiary を使って、時間をかけず

    Apiary でモダンでインタラクティブなAPIドキュメントを作る
  • 1