OpenAPI

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

こんにちは、エキサイト株式会社の平石です。 今回は、SpringdocでAPIのリクエストに対して、付与するアノテーションをご紹介します。 なお、今回のソースコードは以下の環境で動作確認をしています。 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2…

OpenAPI GeneratorでJavaのAPIクライアントを自動生成する

こんにちは、エキサイト株式会社の平石です。 今回は、OpenAPI Generatorを利用してJavaのAPIクライアントを自動生成する方法をご紹介します。 はじめに OpenAPI Generatorとは 準備 環境 使用するAPIドキュメント 依存関係の追加と設定を行う 実際に生成し…

OpenAPI仕様のYAMLファイルからDartコードを自動生成する際に、タグに日本語は使わない方が良いという話

こんにちは、エキサイト株式会社の平石です。 エキサイトホールディングス Advent Calendar 2023の22日目を担当いたします。 OpenAPI仕様に基づいてAPIの仕様を定義したYAMLファイルから、アプリ用のDartコードを自動生成する際に、タグの指定で注意すべき点…

OpenAPIをSpring Bootで自動生成する場合に、リストや配列の情報を補完する方法

こんにちは、エキサイト株式会社の平石です。 こちらの記事で、Spring BootからOpenAPIのドキュメントを自動生成する方法について説明されています。 tech.excite.co.jp しかし、APIのレスポンスにListまたは配列の項目が存在していた場合に、アノテーション…