FastOpenAPI は、 FastAPI の直感的な API ドキュメント作成アプローチを評価しながらも、異なる Python ウェブフレームワークで作業する必要がある開発者向けのソリューションとして登場しました。このライブラリは、 Flask 、 Falcon 、 Sanic 、 Starlette 、および Tornado を含む複数のフレームワークにわたって一貫した OpenAPI スキーマ生成をもたらすことで、Python ウェブエコシステムの重要なギャップを埋めています。
対応フレームワーク
- Falcon
- Flask
- Quart
- Sanic
- Starlette
- Tornado
主な機能
- Pydantic v2によるOpenAPIスキーマの生成
- Pydanticモデルを使用したデータ検証
- FastAPIスタイルのルーティングを提供するプロキシルーティング
- Swagger UIとReDocドキュメントインターフェースのサポート
コードファーストとスペックファーストの API 開発
FastOpenAPI をめぐるコミュニティディスカッションは、コードファーストとスペックファーストの API 開発アプローチの間の議論を再燃させました。 FastAPI そして現在は FastOpenAPI に見られるようなコードファースト開発では、開発者はデコレーターと型アノテーションを使用して API を直接コードで定義できます。このアプローチは Python 開発者にとってより直感的であり、 Python の動的な性質とよく合致します。
対照的に、スペックファースト開発では、まず OpenAPI 仕様書を作成し、その仕様に基づいて API を実装します。このアプローチは事前の作業がより多く必要ですが、大規模なチームや公開 API には利点があります。
「スペックファーストは最近の私の好みのアプローチですが、そこに至るまでには成長が必要でした。同じボイラープレートを何百回も書いて、どれだけの時間を無駄にしていたかに気づくまでは意味がありませんでした。最初のコストは FastAPI アプリを動作させる 10 行のコードよりも高いですが、それを超えると大きな時間の節約になります。」
多くの開発者は、スペックファーストが API の設計と実装前のレビューが必要なコラボレーション環境で特に価値があり、一方でコードファーストは迅速な開発シナリオや個々の開発者の生産性が優先される非公開 API で優れていると指摘しました。
フレームワークの柔軟性とドキュメントの犠牲を伴わない
コミュニティメンバーによって強調された主な利点は、既存のコードベースを維持しながら FastAPI スタイルのドキュメントを獲得できることです。いくつかのコメンターは、新しい FastAPI サービスと並行して従来の Flask アプリケーションで作業していることに言及し、異なるフレームワーク間で一貫したドキュメントの必要性を生み出しています。
FastOpenAPI は、複数のフレームワークで機能するルート定義とドキュメントへの統一されたアプローチを提供することでこの問題に対処しています。これは、すべてのサービスを単一のフレームワークに簡単に移行できないが、一貫した API ドキュメントが欲しい組織にとって特に価値があります。
この実装は、ユーザーによってシームレスと表現されており、既存のコード構造にわずかな変更を加えるだけで、ドキュメント、検証、開発者エクスペリエンスの面で大きな利益をもたらします。
Python の非同期エコシステムの課題
議論はまた、Python の非同期プログラミングエコシステム内のより広範な課題にも触れました。一部の開発者は、同期コードと非同期コードの間の Python エコシステムの分裂に対する不満を表明し、デバッグの困難さと互換性の問題を指摘しました。
FastOpenAPI が Flask のような従来の同期フレームワークと Sanic や Starlette のような非同期フレームワークの両方をサポートしていることは、両方のパラダイムが共存し、特定のプロジェクト要件に基づいて選択される現在の Python ウェブ開発の状態を反映しています。
いくつかのコメンターは、Python の asyncio 実装と Gevent のような代替手段の長所について議論し、Python が並行処理をどのように扱うかについての継続的な緊張を強調しました。 FastOpenAPI は、その並行モデルに関係なく複数のフレームワークをサポートすることでこの議論を回避しています。
フレームワークのサポートと将来の開発
FastOpenAPI は現在 6 つの Python フレームワーク（ Falcon 、 Flask 、 Quart 、 Sanic 、 Starlette 、および Tornado ）をサポートしていますが、コミュニティメンバーは特に Django の追加フレームワークサポートについて問い合わせました。開発者は Django 統合がロードマップにあるが、そのプロジェクト構造のために独自の課題があると示しました。
コミュニティはまた、戻り値の型からの自動レスポンスモデル推論のような潜在的な機能についても議論しました。これによりボイラープレートコードがさらに削減されるでしょう。開発者は将来のアップデートでそのような機能を追加することに前向きな姿勢を示しました。
FastOpenAPI は、Python ウェブエコシステムにおける興味深い進化を表しており、 FastAPI の開発者フレンドリーな側面をより広範なフレームワークにもたらしています。ウェブ API が増え続ける中、ドキュメントを簡素化し、フレームワーク間で開発パターンを標準化するツールは、多様な技術スタックで作業する開発チームにとって重要なニーズを満たしています。
参考: FastOpenAPI