クライアントライブラリ生成

APIリファレンス からダウンロードできるOpenAPI Specification形式のファイルをもとに、クライアントライブラリを生成することができます。

ここでは例として、openapi-generator-cliを使ってクライアントを生成します。

openapi-generator-cliは、 npm を使って以下のコマンドでインストールします。

$ npm install @openapitools/openapi-generator-cli

重要

openapi-generator-cliは、Javaプログラム OpenAPI Generator を実行します。 そのため、以下の手順を行うには、Java実行環境がインストールされ、環境変数 PATH に java コマンドへのパスが含まれている必要があります。

各言語のクライアントライブラリの生成は以下の手順で行います。

プロジェクトルートにて以下のコマンドを実行します。 -i オプションでOpenAPI Specificationファイルを指定してください。 ${VERSION} では v2.4.0 のようなバージョン名を指定してください。

$ ./node_modules/.bin/openapi-generator-cli generate \
  -g go -i https://docs.intdash.jp/api/intdash-api/${VERSION}/openapi_public.yaml \
  -o ./intdash --package-name=intdash \
  --additional-properties=disallowAdditionalPropertiesIfNotPresent=true,enumClassPrefix=true

使用するプロジェクトの go.mod ファイルに replace を追加します。

$ echo "replace path/to/project/intdash => ./intdash" >> go.mod

コードのフォーマットを整えます。

$ gofmt -w ./
$ gomod tidy