見出し画像

APIスキーマ管理を検討した結果、自社開発することになった話をしてきました

2024年11月25日(月)に、トグルホールディングス株式会社と「TSKaigi Kansai 2024 振り返り勉強会」を共催しました。

テーマは「TypeScript活用術」ということで、弊社のFAQ検索システム「Helpfeel」のプロダクトマネージャー、松村 祐貴(niboshi)が、「天下一APIスキーマ管理武道会」というタイトルで発表を行いました。

この発表では、HelpfeelでAPIスキーマ管理の既存ソリューション(OpenAPI、Zodios、aspidaなど)を検討し、最終的に、自社による新規開発の道を選んだ経緯が語られています。あくまでも、Helpfeel開発(フルスタックTypeScript)の視点からですが、同様の課題を感じてる皆さんの参考になれば幸いです。

HelpfeelのAPIスキーマ管理のために新たに開発しているのは「typed-api-spec」。以下のようなコンセプトで開発を進めています。

typed-api-specのコンセプト(箇条書き)
・https://github.com/nota/ty.ped-api-spec
・REST APIに後付けできて、部分的に導入可能
・TypeScriptだけでスキーマやバリデーションを定義できる
・フレームワーク/バリデーションライブラリ非依存
・ゼロランタイム
typed-api-specのコンセプト

すでに、GitHubにて公開していますので、興味ある方は覗いてみてください。

まだ、ドキュメントが未整備ですが、コンセプトや今後の展望を、発表資料に記載していますので、参考にしていただければ。(了)

執筆、写真:風穴 江/Ko Kazaana(windhole)