/
API Caller の使い方

API Caller の使い方

Owned by Haruhide Yasukawa (Unlicensed)
Last updated: Dec 22, 2020

使い方

  • 認証方法
    ユーザーアカウントはシステムリポジトリで管理されます
    システム管理者に連絡してサインアップしてください（API Caller - ユーザの追加方法を参照）
    ログインする環境はアドレスURLで定義されています
    ユーザー（メール）と初期パスワードを使用してシステムにログインしますadmin@openlegacy.comとpassword
    ログインすると、パスワードを変更して、アプリケーションツールバーのユーザー設定からログアウトできます 

  • 仕様のインポート方法 (エンドポイントのエンドポイントリストへの追加)
    アプリケーションツールバーの仕様エディターをクリックすると、アプリケーション内でSwaggerエディターが開きます。
    Swagger仕様をインポートできます（OpenAPI3またはシステムはSwagger 2.0からOpenAPI3への自動変換を提供します）:

    • ファイルをクリック

    • ファイルをインポート (例えば、ymlファイルの追加)

    • 編集をクリック

    • OpenAPI3へ変換 (必要に応じて)

API仕様が要求を満たしたら、[完了]ボタンを押してエンドポイントを確認します

 

  • エンドポイントアクションの実行方法

    • エンドポイントの検索 - Using the Search bar, the user can search Endpoints by name (auto complete search)

    • エンドポイントのランタイムへの公開 - エンドポイントは「ドラフト」編集可能モードで作成されます。実行時に使用する場合は、「公開」する必要があります。エンドポイントメニューを使用するか、複数のエンドポイントを選択して、選択したエンドポイントのステータスを「公開済み」に変更します。使用する準備ができていることを意味します

    • 公開取消- [エンドポイント]メニューを使用して、[編集]をクリックし、選択した[公開済み]エンドポイントのステータスを[ドラフト]に戻します。

    • 公開取消 & 編集 - [エンドポイント]メニューを使用して、[編集]をクリックし、選択した[公開済み]エンドポイントのステータスを[ドラフト]に戻し、エディターを開いてエンドポイントの定義メタデータを変更します

    • エンドポイントの削除 - [エンドポイント]メニューを使用するか、複数のエンドポイントを選択して、生成された1つ以上のエンドポイントを削除します。削除は永続的であり、復元することはできません。

       

       

    • エンドポイントの編集
      エンドポイントの 'ドラフト' モードで、編集メニューから次を変更できます:

      • フィールド長 (エンドポイントメタデータ定義)

        • 例: Input →  body →  {field name} と移動し、フィールド長を変更

      • エンドポイントベース URL

      • エンドポイントパス

      • Http スキーマ(Http/Https)



  • 開発、テスト、本番環境間のエンドポイントの移動方法
    エンドポイントをJSONファイルとしてエクスポート/インポートすることで、開発、テスト、本番などの環境間でエンドポイントを移動できます

    • エンドポイントのインポート - アプリケーションバーの[エンドポイントのインポート]ボタンを使用して、JSONファイルとして使用してエンドポイントリストをインポートします

    • エンドポイントのエクスポート - [エンドポイント]メニューを使用するか、複数のエンドポイントを選択して、1つ以上のエンドポイントをJSONファイルとしてエクスポートします



  • クライアントのダウンロード方法
    メニュー → Generate client をクリックし、エンドポイントに対応するプロキシクライアントを生成します。Zipファイルでダウンロードします。
    メインフレーム環境へファイルを移動し、それらを入力し、URLマップを構成します
    エンドポイントが配置されることを確認します（ランタイム）
    3rd Part APIを呼出します



  • ユーザの追加方法

前提条件: Java 8 がインストールされている.

  1. 添付 jar ファイルをダウンロードします。

  2. Terminal/CMDを起動します。

  3. 引数としてユーザとパスワードを指定し、jarを実行します:
    java -jar api-caller-user-sctipt-provider-1.0.0-all.jar userName password

  4. 次のようなSQL文が出力されます: 
    INSERT INTO iam.users(id, username, password, roles) VALUES ('2721b79c-a127-451e-8301-00a066d414f9', 'userName', '$2y$10$4dU3pVkXOZZ.Sky0rHzORe9iqR/MRUkGdBp7fh3iHtwybYi6namve', '{admin}');

  5. SQL statement in your PostgreSQL データベースでSQL文を実行します。

  6. 完了です。

api-caller-user-sctipt-provider-1.0.0