APIサーバのドキュメンテーションとモックサーバを両立させる方法を複数のプロダクトを通じて行っていました。
easymockやstubcellといった軽量のものを使っていましたが、いかんせんドキュメンテーション能力が弱くただのモックサーバとして、一時的に用意されたが以降はメンテナンスされない、APIの概要を知りたいのに結局サーバのコードを読まねばならない、という課題を抱えていました。
ドキュメンテーションとしてモック用意することで、上記の課題を解決しようと当時探して出会ったのが、APIBlueprintとSwaggerでした。
当時の要求からSwaggerは機能過多で、情報の追従にチームが疲弊するだろうと考え、比較的記述が安易(Markdownという馴染みのあるフォーマットでかける)であると感じたAPI-Blueprintを採用しました。
しかし、API-Blueprintの提供しているモックサーバーは現状の要求に噛み合わず、自身で作成することで導入のハードルを下げました。
実装当時は、テスト・ドキュメント・モックという3種の神器を満たすAPIツールはまだ試行段階でしたが、このOSSを開発・導入することで、以前に比べてこの課題に悩む頻度は減りました。
現状運用上でまだいくつかの課題が残っている部分があるので、今後改修を視野に入れて、また新しい技術の挑戦を行っていくつもりです。