Open API落穂拾い - Qiita

この記事は 株式会社ビットキー Advent Calendar 2022 14日目の記事です。 今回は workhubプロダクトチームの maruware が担当します。 背景 BitkeyではOpen APIを以下のような用途で活用しています。 API仕様、ドキュメント 自社製のジェネレータによるサーバー実装やクライアント実装生成 サブシステムのモックサーバー Open APIに則ることで、1のメリットはもちろん、2によりサーバー実装で統一的なアーキテクチャ・validation・テストなどを得られたり、テストサーバー・クライアント間で整合した実装を得られたりといったメリットがあります。 しかし、残念ながら提供しているAPIはすべてがOpen APIで定義されている状態にはなっておらず、それらについてもOpen APIに載せていく移行を進めています。 その移行作業やジェネレータ整備などを

[sh19910711]

"既存の 非Open APIなAPIはTypeScriptで実装 されており、これをまずOpen API Specに移行する必要 / 何も考えずにやるとyamlをちくちく手で書いていくことになり / 幸いにも typeconv というOSSツールを公開してくれている方がいて" 2022