OpenAPI GeneratorとTypeScriptでBigIntを扱う

by

OpenAPI Generatorとは

OpenAPI Generatorは、APIの設計書として利用される OpenAPI仕様に基づいてコードを自動生成することができるツールです。

OpenAPIは、REST APIの設計/仕様書を記述するために生み出された一連のオープンソースツールを指します. OpenAPI Specificationと呼ばれる、REST APIの仕様を記述する取り決めに従って仕様が策定されており、ドキュメントの自動作成はもちろん、Mockupの生成やコードの生成などもサポートしています.

OpenAPI Generatorは、yamlファイルにAPIの仕様を定義することで各開発言語でAPIクライアント/サーバーのコードを自動で生成できるツールです. これにより、APIの仕様書をベースに話を進めることができ、API仕様書と実装が乖離する場面を減らすことが可能です.

また、OpenAPI Generatorは多くの言語、フレームワーク、ライブラリに対応しており、その中にはTypeScriptも含まれています. これにより、TypeScriptでの開発においてもAPIの仕様書からコードを自動生成し、効率的な開発を行うことが可能となります.

TypeScriptでのBigIntの扱い

TypeScriptのBigInt型はJavaScriptのBigIntデータ型をサポートする機能で、64ビットを超える整数値を扱うために使用されます. BigIntは理論上はメモリの制約まで任意の大きさの整数を表現できます.

リテラル表記

BigInt値は数値の末尾にnを付けることで表現します（例：100n）. TypeScriptでBigIntリテラルを用いるには、コンパイラーオプションのtargetをes2020以上にする必要があります.

型注釈

TypeScriptでBigInt型を型注釈するには、bigintを用います. 例えば、const x: bigint = 100n;のように使用します.

BigInt関数

BigInt型はBigInt関数を使って作ることができます. BigInt関数は第1引数に数値もしくは文字列を渡します. 例えば、const x = BigInt(100);やconst y = BigInt("9007199254740991");のように使用します. TypeScriptでBigInt関数を用いるには、コンパイラーオプションのlibをes2020以上にする必要があります.

bigint型とnumber型の演算

bigint型とnumber型はそのままでは一緒に演算をすることはできません. どちらかに型を合わせる必要があります. number型が小数部を持っていない限り、より表現幅の広いbigint型に合わせる方が無難です. 例えば、const i = 2n + BigInt(3);のように使用します.

OpenAPI GeneratorでTypeScriptの型定義を自動生成する方法

OpenAPI Generatorを使用してTypeScriptの型定義を自動生成する方法は以下の通りです:

1. OpenAPI Generatorのインストール

まず、npmを使用してOpenAPI Generatorをインストールします:

npm install -D @openapitools/openapi-generator-cli

2. コードの自動生成

次に、以下のコマンドを実行してコードを自動生成します:

openapi-generator-cli generate -g typescript-fetch -i <生成元ファイル> -o <生成先のフォルダ>

ここで、-gオプションは生成するコードの種類を指定します. この例ではtypescript-fetchを指定しています.

3. Dockerを使用した導入方法

Dockerを使用すると、環境差分がなく、一般的な導入方法となります. 公式のDockerイメージが配布されているため、以下のコマンドで実行できます:

docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli generate -i /local/openapi.yaml -g typescript-fetch -o /local/dist/target

以上がOpenAPI Generatorを使用してTypeScriptの型定義を自動生成する基本的な手順です. これにより、APIの仕様書から直接TypeScriptの型定義を生成し、効率的な開発を行うことが可能となります.

BigIntを扱う際の注意点

TypeScriptやJavaScriptでBigIntを扱う際には以下の点に注意が必要です:

1. BigIntとNumberの演算

BigInt型とNumber型はそのままでは一緒に演算をすることはできません. どちらかに型を合わせる必要があります. Number型が小数部を持っていない限り、より表現幅の広いBigInt型に合わせる方が無難です. 例えば、const i = 2n + BigInt(3);のように使用します.

2. BigIntとNumberの型変換

BigIntをNumberへ変換する際には精度が落ちることがあるので、相互に変換する場合には注意が必要です. BigInt値は、値が2^53を超えることが合理的に予想される場合にのみ使用することを推奨します. BigInt値とNumber値の間で型変換を行わないことを推奨します.

3. BigIntとテンプレートリテラルやアロー関数

BigInt型はテンプレートリテラルやアロー関数内で使用できません.

以上がBigIntを扱う際の主な注意点です. これらの点を理解しておくことで、BigIntを安全に扱うことができます.

まとめ

この記事では、OpenAPI GeneratorとTypeScriptでBigIntを扱う方法について詳しく解説しました.

まず、OpenAPI Generatorとは何か、その特徴と利点について説明しました. 次に、TypeScriptでのBigIntの扱い方とその注意点について解説しました. そして、OpenAPI Generatorを使用してTypeScriptの型定義を自動生成する方法を具体的に示しました.

最後に、BigIntを扱う際の注意点を挙げ、安全にBigIntを扱うためのポイントを説明しました.

これらの知識を活用することで、TypeScriptでの開発効率を向上させることができます. また、OpenAPI Generatorを使用することで、APIの仕様書から直接型定義を生成し、APIの仕様と実装の乖離を防ぐことが可能となります.

これからもTypeScriptとOpenAPI Generatorを活用して、より効率的な開発を行っていきましょう.

コメントする