OAS 2 このページは、OpenAPI仕様バージョン2（旧Swagger）に適用されます。
最新バージョンについては、OpenAPI 3のページをご覧ください。

Swaggerとは？

Swaggerを使用すると、マシンが読み取れるようにAPIの構造を記述できます。APIが自身の構造を記述できる機能は、Swaggerのあらゆる素晴らしさの根源です。なぜそんなに優れているのでしょうか？ APIの構造を読み取ることで、美しくインタラクティブなAPIドキュメントを自動的に構築できます。また、多くの言語でAPIのクライアントライブラリを自動的に生成したり、自動テストなどの他の可能性を探求したりすることもできます。Swaggerは、APIにAPI全体の詳細な説明を含むYAMLまたはJSONを返すように要求することでこれを行います。このファイルは、基本的にOpenAPI仕様に準拠するAPIのリソースリストです。仕様では、次のような情報を含めるように求められます。

• APIがサポートするすべての操作は何ですか？
• APIのパラメータは何ですか？また、どのようなものを返しますか？
• APIには承認が必要ですか？
• APIの使用条件、連絡先情報、ライセンスなどの楽しいものも含まれています。

APIのSwagger仕様を手動で記述することも、ソースコードのアノテーションから自動的に生成することもできます。コードからSwaggerを生成できるツールの一覧については、swagger.io/open-source-integrationsを確認してください。

APIのSwagger仕様を作成しました。次に何をすればよいですか？

SwaggerがAPI開発をさらに推進するのに役立つ方法がいくつかあります。

• デザインファーストのユーザー：Swagger Codegenを使用して、APIのサーバーのスタブを生成します。残りはサーバーロジックを実装することだけで、APIは稼働準備完了です！
• Swagger Codegenを使用して、40以上の言語でAPIのクライアントライブラリを生成します。
• Swagger UIを使用して、ユーザーがブラウザで直接API呼び出しを試すことができるインタラクティブなAPIドキュメントを生成します。
• 仕様を使用して、API関連ツールをAPIに接続します。たとえば、仕様をSoapUIにインポートして、APIの自動テストを作成します。
• その他にも！Swaggerと統合するオープンソースおよび商用ツールを確認してください。