面接官：Swagger（OpenAPI）について説明してください。
私：Swagger（OpenAPI）は、APIの設計、構築、ドキュメント化、そして利用を支援するオープンソースのフレームワークです。以前、ECサイトのバックエンドAPIを開発した際、Swagger（OpenAPI）の仕様に基づいてAPI定義書を作成しました。
API定義書は、YAMLまたはJSON形式で記述され、APIのエンドポイント、リクエストパラメータ、レスポンスの形式などを詳細に記述します。
このAPI定義書に基づいてSwagger UIを生成し、開発チーム全体で共有しました。その結果、APIの仕様に関する認識のずれが減少し、開発効率が20%向上 しました。
さらに、APIのモックサーバーを自動生成し、フロントエンド開発チームはバックエンドAPIが完成する前に、APIをテストすることができました。
現役エンジニアによる深掘り解説
メリット
ドキュメントの自動生成: Swagger UIなどのツールを用いて、APIドキュメントを自動的に生成できます。これにより、手動でのドキュメント作成にかかる時間と労力を大幅に削減できます。APIの変更があった場合でも、定義ファイルを更新するだけでドキュメントを最新の状態に保つことができます。
開発効率の向上: APIの仕様を明確に定義することで、フロントエンドとバックエンドの開発チーム間のコミュニケーションが円滑になり、開発効率が向上します。APIクライアントライブラリの自動生成も可能になり、開発者はAPIをより簡単に利用できます。
テストの容易化: Swagger EditorやSwaggerHubなどのツールを利用することで、APIのテストを容易に行うことができます。定義ファイルに基づいてモックサーバーを生成し、APIが完成する前にテストを実施することも可能です。
APIの標準化: OpenAPI仕様に準拠することで、APIの設計と実装を標準化できます。これにより、異なるチームや組織間でAPIを共有しやすくなり、相互運用性が向上します。
デメリット
学習コスト: Swagger（OpenAPI）を使いこなすためには、YAMLまたはJSONの記述方法、OpenAPI仕様に関する知識、そして関連ツールの使い方を学ぶ必要があります。
初期設定の複雑さ: Swagger（OpenAPI）の設定は、プロジェクトの規模や複雑さによっては煩雑になることがあります。特に、既存のAPIにSwagger（OpenAPI）を組み込む場合は、既存のコードを修正する必要があるかもしれません。
定義ファイルのメンテナンス: APIの変更に合わせて、Swagger（OpenAPI）の定義ファイルを常に最新の状態に保つ必要があります。定義ファイルが古くなると、ドキュメントやテストの結果が誤ったものになる可能性があります。
⚠️ 面接突破のワンポイント
- 「Swagger（OpenAPI）を利用したAPI設計の経験」を具体的に説明できるように準備しましょう。例えば、どのようなAPIを設計し、どのようなツールを利用したか、そしてどのような課題を解決できたのかを説明できるようにしましょう。
- 「OpenAPI仕様のバージョン」を意識しましょう。OpenAPI Specification 2.0 (Swagger 2.0) と OpenAPI Specification 3.0 (OAS 3.0) の違いについて説明できるようにしておくと、より深い理解を示すことができます。
