StripeのドキュメントからCLIコマンドを実行したり、コードを生成してみる

StripeのドキュメントからCLIコマンドを実行してみました。
2023.06.29

プログラムからStripeのAPIを利用するとき、最初にCLIとかで実験することがあります。 このとき、パラメータの指定方法とかで悩むことがあります。

そんなとき、「Stripe のドキュメントからCLIコマンドを実行したり、オプション指定したり、ライブラリを利用するコードを生成できるよ」と教えてもらったので、試してみました。

おすすめの方

  • StripeのAPI ReferenceでCLIコマンドを実行したい方
  • StripeのCLIでオプション指定の方法を知りたい方

Stripe CLI(オンライン)を起動する

Stripeアカウントにログインしているブラウザで試します。

Stripeのドキュメントにアクセスして、オンラインのCLIを起動する

Stripeのドキュメントにアクセスします。

  • https://stripe.com/docs

右下にある次のボタンを押します。

Stripeドキュメントの右下のボタンを押す

Stripe CLI(オンライン)が起動しました。

StripeドキュメントでCLIが実行できるようになる

API Explorerを起動する

「API Explorer」を選択すると、起動します。

API Explorerを押す

任意のResourceやMethodが選択できます。

API Explorerの様子

API Explorerでresourceを選択する

API Explorerでmethodを選択する

必須パラメータやオプションパラメータの入力ができます。

リクエストを実行する

リアルタイムで右側のコマンドに反映されます。そして、そのまま実行できます。便利!

リクエストを実行した

コードを生成する

任意の言語を選択します。

コード生成したい言語を選択する

続いて、言語選択の左側にある「Print SDK code」を選択すると、右側にコードが生成されました。便利!

コード生成する

もっと複雑なAPIで試してみる

Checkoutのセッションを作成してみます。 ひとつの必須パラメータとたくさんのオプションパラメータがあります。

API ExplorerでCheckoutセッション作成をしてみる

hashのarrayは、階層ごとに設定できました。

hashのarrayのパラメータを入力する

hashのパラメータを入力した

hashのarrayのパラメータを入力した

enumは選択肢から選びます。

enumのパラメータを選択する

コマンドを実行すると、成功しました。

APIを実行した

コード生成もできました。

コードを生成した

さいごに

StripeのドキュメントからCLIを実行したり、コード生成してみました。 とくにCLIで軽く試せるのは嬉しいですね。CLI特有のパラメータ指定方法で悩んだりハマったりすることが無くなるのが嬉しいです。 どなたかの参考になれば幸いです。

参考