ParameterObject

このタグの解説について

この解説文は、すでに終了したサービス「はてなキーワード」内で有志のユーザーが作成・編集した内容に基づいています。その正確性や網羅性をはてなが保証するものではありません。問題のある記述を発見した場合には、お問い合わせフォームよりご連絡ください。

エキサイト TechBlog.•1日前

JavaのSpringdocはAPIのリクエストパラメータをどのように認識しているのか？

こんにちは、エキサイト株式会社の平石です。エキサイトホールディングス Advent Calendar 2024の10日目を担当いたします。 Springdocライブラリを利用することで、簡単にOpenAPI仕様に則ったAPIドキュメントを自動生成することができます。しかし、このライブラリを使って開発を行う中で、APIのパラメータをどのように認識しているのか少し気になったので、その調査をしてみました。今回は、その内容をブログとして残したいと思います。なお、今回紹介するのはspringdoc-openapi v2.7.0での動作であり、今後変更される可能性はありますのでご注意ください。共…

#OpenAPI#Springdoc#Java#ParameterObject

関連ブログ

エキサイト TechBlog.•6ヶ月前

OpenAPI Generatorで生成したAPIクライアントをコンパイルせずに利用する

こんにちは、エキサイト株式会社の平石です。今回は、OpenAPI Generatorで自動生成したAPIクライアントをコンパイルせずに利用する方法をご紹介します。はじめに環境手順 1. これまでの方法で一旦生成する 2. 生成したファイルを実行するために必要な依存関係を確認する 3. 依存関係を自身で管理するbuild.gradleに追加する 4. OpenAPI Generatorの設定を確認、適宜変更し再生成する 5. 不要なファイルを削除する動作確認終わりに参考文献はじめに OpenAPI Generatorと、Javaでの基本的な利用方法は以下のブログをご覧ください。 …

エキサイト TechBlog.•9ヶ月前

SpringdocでAPIの情報を補足する際、リクエストパラメータには@Parameterを使うべきという話

こんにちは、エキサイト株式会社の平石です。今回は、SpringdocでAPIのリクエストに対して、付与するアノテーションをご紹介します。なお、今回のソースコードは以下の環境で動作確認をしています。 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.3.0' Java 21 SpringBoot 3.2.2 はじめに SpringdocはOpenAPI仕様のAPIドキュメントを自動で生成してくれるライブラリです。ドキュメントを書く手間も省けますし、Swagger UIを利用すればAPIの動作確認もできるので、事業部でも積極的に活用して…