システム開発で思うところ

Javaで主にシステム開発をしながら思うところをツラツラを綴る。主に自分向けのメモ。EE関連の情報が少なく自分自身がそういう情報があったら良いなぁということで他の人の参考になれば幸い

Swaggerのメモ

SpringFox

SpringFox by springfox

メモ

ぱっと調べると SpringでSwaggerは SpringFox くらいの 感じだったし、既存のプロジェクトでも使っていたから採用はしたものの、最新バージョン(3_0_0)にすると SpringBoot2.6系にしたら 起動が出来なかった。

swagger-starter3.0 not support springBoot2.6.x version · Issue #3934 · springfox/springfox · GitHub (他にも類似のissueがあった気もするけど見つけられなかった)

メンテナンスも止まっているみたい(最終コミットが 2020年10月)

Commits · springfox/springfox · GitHub

positon の順番が効かないとかもあるし、このまま使い続けるのは良くないかも。。

リンク

とはいえ、色々と参考になる(調べるときのヒントになる)かもしれないので気になる情報はメモしておく。

SpringFoxでのSwaggerのリクエスト・レスポンス説明の共通化 | GROUP DEV BLOG | TECHNO DIGITAL

stringdoc-openapi

OpenAPI 3 Library for spring-boot

メモ

SpringFoxよりも こっちを使うようにした方が良いかも、、 ということで まずは情報収集。 少なくとも Swagger用ライブラリで SpringBootのバージョンアップの弊害になっているのは困る。
私のプロジェクトは始まったばかり。今なら間に合う。

リンク

SpringFoxからspringdoc-openapiに移行してみた - Qiita

OpenAPI 文書のカスタマイズ

Documenting a Spring REST API Using OpenAPI 3.0 | Baeldung

@RestControllerAdvice and @ResponseStatus(HttpStatus.OK) overriding default response for @RestController methods · Issue #565 · springdoc/springdoc-openapi · GitHub

Configure default response Message · Issue #381 · springdoc/springdoc-openapi · GitHub

springdoc-openapiでOpenAPI形式のAPIドキュメントを生成する