springdoc/springdoc-openapi

これは何？

主な機能

• 01実行時にSpring BootのコードからOpenAPI 3の定義をJSONおよびYAML形式で生成します。
• 02APIを閲覧するためのSwagger UIまたはScalarページを提供します。
• 03Spring Web MVC、WebFlux、関数型エンドポイントに対応しています。
• 04Spring Security、OAuth 2、Spring Data REST、HATEOASと連携します。
• 05@NotNull、@Min、@Max、@SizeなどのBean Validationアノテーションを読み取ります。
• 06ビルド時に定義を生成するMavenおよびGradleプラグインを提供します。

ユースケース

• OpenAPIファイルを手書きせずに、Spring Bootで構築したREST APIをドキュメント化する。
• フロントエンドチームや外部チームに、エンドポイントを試せるインタラクティブなページを提供する。
• MCP経由でSpring APIをAIエージェント向けのツールとして公開する。
• クライアントコードの生成やコントラクトチェックに使うOpenAPIファイルをビルド時に生成する。

収録されている特集

トピック

よくある質問

springdoc-openapi とは？

実行時にコントローラーを調べ、Spring Bootアプリ向けのOpenAPI 3ドキュメントとSwagger UIまたはScalarページを生成します。 springdoc-openapiは、実行時にコントローラー、設定、バリデーションアノテーション、Bean Validationの制約を調べるSpring Bootアプリ向けのJavaライブラリです。OpenAPI 3の定義をJSONとYAMLで提供し、操作可能なSwagger UIまたはScalarページも生成します。スターター依存関係を1つ追加するだけで利用を始められ、必須の設定はありません。

springdoc-openapi は無料で使えますか？ライセンスは？

springdoc-openapi は Apache-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

springdoc-openapi は今もメンテナンスされていますか？

活発にメンテナンス中。springdoc-openapi の最終コミットは 2026年11月6日 です。

springdoc-openapi は何に使えますか？

OpenAPIファイルを手書きせずに、Spring Bootで構築したREST APIをドキュメント化する。 フロントエンドチームや外部チームに、エンドポイントを試せるインタラクティブなページを提供する。 MCP経由でSpring APIをAIエージェント向けのツールとして公開する。 クライアントコードの生成やコントラクトチェックに使うOpenAPIファイルをビルド時に生成する。

springdoc-openapi はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/springdoc/springdoc-openapi