REST APIドキュメント生成パターン - ✘╹◡╹✘
REST API用のドキュメントを生成するときにどうやってるかについて雑記を残しとく。 概要 実装とドキュメントの乖離を避けるためには、同じ意味情報を二箇所以上に定義することを避ける必要がある。そのための方法として、実装それ自身か、もしくは実装が参照している何らかのメタデータを元にしてドキュメントを生成したり、テストの実行結果からドキュメントを生成するというパターンがある。 テストから Cookpadでは、autodocというライブラリを利用して、RSpecでテストを実行している途中で得られたメタデータからドキュメントを生成している。これはテストの実行結果からドキュメントを生成するパターン。 これは実現方法としてはかなり特殊な部類。このパターンが最も効果的に働くのは、ドキュメント生成のために余分な開発コストはあまり掛けたくないが、テストは真面目に書いている OR 真面目に書いてほしい、とい
デスマをやってみた - satomicchyのつぶやき
デスマーチとは 【 death march 】 〔 死の行進 〕 - 意味/解説/説明/定義 ： IT用語辞典 デスマをやってみた。過去形だけど、リリース日が延期になって、スッキリ終わったわけではない。これからどう進めるかはこれから相談。知人によれば、それもまたデスマらしいと言う。 S/W業界のデスマは初めてだけど、前職の業界でも似たようなことはあった。そのときは、企業体質なのかラッキーだったのか、女性ていうのが考慮されてそれなりには帰らせてくれた。でも今回は、フリーランスになって初めてのデスマで、守ってくれるものなんてない。自分で自分のマネジメントをしなくちゃいけない。 自分マネジメントのためのステップとして、自分観察したことを書いておく。 コードに没頭すると日本語が理解できなくなる現象 デスマ真っ最中は、起きてる間はほとんどPCに向かってコードを書いている状態で、作業をするときは「仕様
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
