なんだかんだ Test::JSON::RPC::Autodoc をつくった - ゆーすけべー日記

2014/11/12 19 users RPC JSON-RPC RESTful JSON iOS

Autodoc について RESTfulもしくはそれに準ずるWeb APIやJSON-RPCなどのバックエンドとモバイルアプリ間の通信を実装する案件はおそらく昨今非常に多いかと思われます。弊社もJSON-RPCを裏方に持ち、iOSとAndroidアプリ、もしくはフロントのWebがそれを呼び出す仕組みを持っています。その際にWeb APIやRPCを呼び出すための「ルール」をどのようにお互いの技術者が... 続きを読む

Apiary - r7kamura per second

2014/02/13 88 users Apiary RAML Swagger API ドキュメント

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

Autodoc - r7kamura blog

2013/12/01 150 users rspec API 斥力 テスト r7kamura blog

闇Advent Calendar 1日目の記事として、最近の開発における心の闇に触れます。 最近開発した Autodoc というツールについて簡単に説明した後、 この手のツールの開発にあたって考えていた、 創作活動の在り方や、社会の斥力、25歳定年説などについて触れようと思います。 Autodocとは Rack applicationで実装されたAPIに対して、RSpecで書かれたテストを元にAP... 続きを読む

Quipper のスピード感 - @kyanny's blog

2013/10/22 67 users Quipper Rails request spec API

2013-10-22 Quipper のスピード感 先日、ブログ記事を読んでいて autodoc というツールを見つけた。 Rails の Request Spec から自動的に API ドキュメントを生成するというもの。コードとドキュメントが食い違ってしまう問題を解決できるかも、と思って試しに Quipper 社内で紹介してみた。 当初は「良さそうだね、でも今使っている API サーバー用フレー... 続きを読む

Rails でつくる API のドキュメントを自動生成してくれる autodoc がすごい - 彼女からは、おいちゃんと呼ばれています

2013/10/20 281 users antipop おいちゃん Rails リリ API

2013-10-20 Rails でつくる API のドキュメントを自動生成してくれる autodoc がすごい Rails 最近 Rails で API をつくりはじめたのですが、ドキュメントをどうしようかなと悩んでいまして。なにかイイ感じに自動生成してくれるツールはないものかと探していたら、@hsbt さんと id:antipop さんがまさにズバリのものを教えてくれました。 先日ふわっとリリ... 続きを読む

r7kamura/autodoc · GitHub

2013/06/07 44 users GitHub r7kamura

README.md Autodoc Auto-generate API documents from your request-specs. Installation Usage All request-specs tagged with :autodoc will be auto-documented. You must include a HTTP method and request pat... 続きを読む