Repolode
投稿する
swagger-api

swagger-api/swagger-core

コードのアノテーションやJAX-RS REST APIからOpenAPI仕様を生成するJavaライブラリ。OpenAPI 3.xに対応。

GitHub で見る公式サイト
スター
7,535
フォーク
2,255
未解決の Issue
219
最終コミット
一昨日

これは何？

Swagger Coreは、OpenAPI SpecificationのJava実装です。JavaアプリケーションのアノテーションやRESTリソースクラスを読み取り、エンドポイント、パラメーター、リクエストボディ、レスポンスモデルを記述したOpenAPIドキュメントを生成します。このドキュメントはSwagger UIなどのツールでレンダリングし、インタラクティブなAPIドキュメントとして表示できます。

JAX-RS 2アプリケーションを対象としており、javax名前空間とJakarta名前空間の両方に対応する成果物セットを提供しています。バージョン2.2.0以降はOpenAPI 3.1に対応し、旧バージョンの1.x系列はOpenAPI 2.0をサポートします。MavenやGradleのビルドで各モジュールのバージョンを管理するためのBOM成果物も用意されています。

このリポジトリはMavenのマルチモジュールビルドで、Java 11以降が必要です。インテグレーションサンプルは別のswagger-samplesリポジトリに移管されています。

主な機能

  • 01JavaのアノテーションやJAX-RSリソースからOpenAPI 3.xドキュメントを生成します。
  • 02javaxとJakartaの両方の名前空間に対応する成果物を提供します。
  • 03バージョン2.2.0以降でOpenAPI 3.1をサポートします。
  • 04MavenやGradleで依存関係のバージョンを統一するためのBOMを提供します。

ユースケース

  • コードからOpenAPI仕様を生成して、Java REST APIをドキュメント化する。
  • JAX-RSサービスにインタラクティブなAPIドキュメントを追加する。
  • APIドキュメントを維持しながら、Javaサービスをjavax名前空間からJakarta名前空間へ移行する。

使う前に知っておきたいこと

  • Java と JAX-RS 2 API を対象としているため、他のスタックには適していません。

トピック

#openapi#swagger#rest-api#java#api-documentation#jax-rs#hacktoberfest#open-source#openapi-specification#openapi3

よくある質問

swagger-core とは？
コードのアノテーションやJAX-RS REST APIからOpenAPI仕様を生成するJavaライブラリ。OpenAPI 3.xに対応。 Swagger Coreは、OpenAPI SpecificationのJava実装です。JavaアプリケーションのアノテーションやRESTリソースクラスを読み取り、エンドポイント、パラメーター、リクエストボディ、レスポンスモデルを記述したOpenAPIドキュメントを生成します。このドキュメントはSwagger UIなどのツールでレンダリングし、インタラクティブなAPIドキュメントとして表示できます。
swagger-core は無料で使えますか？ライセンスは？
swagger-core は Apache-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
swagger-core は今もメンテナンスされていますか？
活発にメンテナンス中。swagger-core の最終コミットは 2026年11月5日 です。
swagger-core は何に使えますか？
コードからOpenAPI仕様を生成して、Java REST APIをドキュメント化する。 JAX-RSサービスにインタラクティブなAPIドキュメントを追加する。 APIドキュメントを維持しながら、Javaサービスをjavax名前空間からJakarta名前空間へ移行する。
swagger-core はどこで入手できますか？
ソースコードとインストール手順は GitHub にあります：https://github.com/swagger-api/swagger-core

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト