🐡

OpenAPI（Swagger）を使用した3scale API管理設定のインポートの方法

2023/12/21に公開

はじめに

この記事では、Ruby環境の設定から始め、3scale Toolboxのインストール方法、そして3scale管理ポータルでのアクセストークンの取得と使用方法について説明します。

3scale Toolboxを使用する前に、Rubyの環境を準備する必要があります。Rubyが既にインストールされていない場合は、Rubyの公式サイトからダウンロードしてインストールしてください。

Ruby環境が整ったら、次に3scale Toolboxをインストールします。ターミナルまたはコマンドプロンプトを開き、以下のコマンドを実行してください。

gem install 3scale_toolbox

インストールが完了したら、次のコマンドでインストールが正しく行われたことを確認します。

3scale -v

3scale Toolboxを使用するためには、3scaleの管理ポータルでアクセストークンを取得する必要があります。以下の手順に従ってアクセストークンを取得してください。

3scaleの管理ポータルにアクセスします。
「Personal」セクションに移動し、「Tokens」ページを開きます。
新しいアクセストークンを作成します。
アクセストークンが作成されたら、以下のコマンドを使用して3scale Toolboxに追加します。

3scale remote add <アクセストークンの名前> http[s]://<access_token>@<3scale-instance-domain>

追加されたリモートを確認するには、次のコマンドを実行します。

3scale remote list

3scale Toolboxを使用してOpenAPI仕様を3scaleにインポートするには、以下のコマンドを実行します。

3scale import openapi -d <アクセストークンの名前> <OpenAPI仕様ファイルパス>

読み込みにエラーが発生する可能性があります。OSAファイルの記述を訂正することで対処できることがあります。