メニューを閉じる

テクノモバイルグループ

メニューを開く

2020.03.31

未分類

SpringFoxでのSwaggerのリクエスト・レスポンス説明の共通化

SpringFoxについて

  • ・Spring Bootで作られたAPI向けのライブラリ。
  • ・導入すると、サーバーがSwagger Specをjsonで返してくれるようになる。
  • ・ソースコードにコメントを書く感覚でSwaggerを利用できるようになるので便利。

公式github

この記事では、SpringFoxにおけるリクエスト・レスポンス説明の共通化をいくつか紹介します。

1.group単位で共通のパラメータを設定する

springfoxはURLPathで区切られたgroupという単位に分けることができます。
このgroup単位で共通のリクエスト・レスポンスパラメータを設定することができます。

 

globalResponseMessageが共通のレスポンスパラメータ説明の付与、

globalOperationParametersが、共通のリクエストパラメータ説明の付与です。

URLPathで区切るので、例えば「https://hoge.jp/api/~以下は、すべて共通のパラメータを持ちたい」といった時に使います。

参考:公式ドキュメント

2.継承元のClassに設定する

この例のように書くと継承先のClassのAPI全てに@ApiResponsesが適応されます。Class単位で共通のレスポンスを設定したい場合に使えます。

SpringFoxはいろいろな書き方のできるライブラリなので、「こんなことできないかな?」と思ったら、一度公式ドキュメントを探ってみるといいかもしれません。


【テクノモバイルではエンジニア/デザイナーを積極採用中です!】

下記項目に1つでも当てはまる方は是非、詳細ページへ!
  • 自分でアプリを作ってみたい
  • ITで世の中にワクワクを生み出したい
  • 使いやすさ、デザインにこだわったWebサイトを開発したい

採用情報の詳細はこちら


Qangaroo(カンガルー)

  • 徹底した見やすさと優れた操作性で、テストの「見える化」を実現。
  • テストの進捗が見える。開発がスマートに進む。
  • クラウド型テスト管理ツール『Qangaroo(カンガルー)』
https://qangaroo.jp/

最近の記事

SNS共有

X CLOSE
X CLOSE
X CLOSE