API Caller RESTful API ドキュメント

Postman からの API Caller の実行

https://docs.google.com/document/d/1vkDek8aHX1vfu0oDOzNltW47YQl7LXmi1Rb-Vh61rOc/edit?usp=sharing

認証トークンの取得方法と使い方

この説明では、次を利用しています http://mock-api-caller.openlegacy.com/ DNS。

Postmanを利用し、次のヘッダを入力します :

POST: http://mock-api-caller.openlegacy.com/iam/auth/token

ドロップダウンリストから、Body → select row → select JSON と選択します。
JSON 形式のユーザ名とパスワードを入力します。

例:

{"username": "admin@openlegacy.com", "password": "password"}

3. ログインが正しい場合、レスポンスボディにトークンを受け取ります。

JWKSの取得方向

JWKS は公開鍵で、簡単なGETメソッドで受け取ることができます。

Postmenを利用し、次のヘッダを入力します:
GET: http:/mock-api-caller.openlegacy.com//iam/.well-known/jwks.json
送信します。
JWKS がレスポンスボディに返されます。
{ "keys": [ { "alg": "RS256", "kty": "RSA", "use": "sig", "n": "****", "e": "****", "kid": "****", "x5c": [ "****" ], "x5t": "****" } ] }

トークンでのログイン方法

各エンドポイントで、認証のためにヘッダにトークンを追加しなければなりません。

Authorization → choose Bearer Token from the Type drop-down listを選択します。
テキストボックスにトークンを入力します。
Headerへ移動します。

key: Authorization
value: Bearer <The Token you Received>

これでPostmanから、API Callerを利用することができます。

注意! 数回でトークンのセッションは終了し、新規のトークンが必要となります。

ユーザ管理エンドポイント

ユーザの追加 -エンドポイント

次のURLを入力します:

POST: http://mock-api-caller.openlegacy.com/iam/api/v1/user/create

Body → select row → select JSON from the checklistを選択します。
ユーザの詳細と共に、次の JSON を編集します。

   {
"username": "username@email.com",

"password": "password",

"is_admin": false

    }

3. ボディリクエストに JSON を挿入します。

4. 送信します。

新規ユーザを作成することができます。

ユーザの削除 - エンドポイント

ユーザ名でユーザを削除します。

次の URLを入力します:

DELETE: http://mock-api-caller.openlegacy.com/iam/api/v1/user/delete

2. Body → select row へ移動し、チェックリストから JSON を選択します。

3. 削除したいユーザの名前でJSONを編集します。

{"username": “username”}

4. リクエストボディにJSONを挿入します。

5. 送信します。

ユーザを削除することができます。

API Caller エンドポイントの使い方

全エンドポイント-エンドポイントの取得

このエンドポイントは、API Callerのすべてのエンドポイントを見ることができます。

次の URLを入力します:

GET: http://mock-api-caller.openlegacy.com/api/v1/endpoints

2. 送信します。

すべてのエンドポイントを確認することができます。

変換-エンドポイント

Swagger 2.0 を利用している場合、use the convert-API エンドポイントでエンドポイントをSwagger 2.0 から OpenAPI 3.0へ変換します。

次の URLを入力します:

POST: http://mock-api-caller.openlegacy.com/api/v1/specification/openapi/convert

2. Body へ移動し、select row のチェックリスから JSON を選択します。

3. リクエストボディに変換したいJSONをペーストしすます。

4. 送信します。

OpenAPI 3.0 JSONへ変換されます。

パース-エンドポイント

Swagger仕様ファイルの内容を入力として取得し、それを解析し、解析結果をエンドポイントに変換して、エンドポイントをユーザーに返すサービス。

次の URLを入力します:

POST: http://mock-api-caller.openlegacy.com/api/v1/specification/openapi/parse

2. OpenAPI 3.0形式のSwagger仕様があることを確認し（必要に応じて/ api / v1 / Specification / openapi / convertエンドポイントを使用）、それを文字列化します。

3. Body へ移動し、 select row → チェックリスからテキストを選択します。

4. 文字列化されたSwagger仕様をリクエストボディにコピーします

5. 送信します。

バックグランドで: エンドポイントt - POST: /api/v1/blunk/create が呼び出されてエンドポイントが作成され、DBに保存されました。新しいエンドポイントが正常に作成されました。

削除- エンドポイント

エンドポイントIDまたはエンドポイントIDのセットを受け取り、対応するエンドポイントを削除します。

次の URLを入力します:

DELETE: http://mock-api-caller.openlegacy.com/api/v1/endpoints/bulk/delete

2. Bodyへ移動し、 → select row → チェックリスから JSON を選択します。

3. 削除したいエンドポイントIDでJSONを編集します。

    {
               "endpointsIds": [

                  "endpoint-id"

                 ]

              }

4. ボディリクエストに JSON を挿入します。

5. 送信します。

エンドポイントを削除することができます。

インポート - エンドポイント

Swagger仕様をAPI Caller にインポートする場合、仕様の各エンドポイントは、派生元の仕様への参照も保持します。

仕様名は、Swagger Info-> titleプロパティから取得されます
各Specは一意の識別子 (UUID) を持ちます- specId
- Swaggerファイルで info.title が指定されていない場合:
  - デフォルト名が生成されます: Specification_xxxxxxx
  - 仕様ID(uuid)の最後の7桁
    例: Specification_1ab23tt
各えんは仕様への参照を保持します
同じSpecID(UUID)を持つエンドポイントが存在する場合、既存のエンドポイントは（仕様名を含むよう）更新され、ステータスは保持されます

次の URLを入力します:

POST: http://mock-api-caller.openlegacy.com/api/v1/endpoints/import

2. Bodyへ移動し、 → select row → チェックリスから JSON を選択します。

3. ボディにインポートしたいエンドポイントのSwagger仕様JSONを入力します。

注意! IDフィールドを削除してください。

4. 送信します。

これでエンドポイントのインポートに成功しました。

エクスポート - エンドポイント

同じSwagger仕様から派生したすべてのエンドポイントは、API Call でSpec IDを指定することにより、1回の呼び出しでエクスポートできます。結果のJSONファイルには、関連するすべてのエンドポイントとそれに関連する仕様が含まれます。

複数のエンドポイントを単一のJSONファイルにエクスポートする場合、エクスポートされたエンドポイントのベースURLを変更できます。これにより、1つの環境で複数のエンドポイントをエクスポートし、別の環境にインポートすることが容易になります。

APIは、エンドポイントIDのセットを受け取り、1つ以上のエンドポイントでエクスポートオプションを使用すると、対応するエンドポイントを返します。そのロジック内で、POSTを呼び出します：/ getバルクエンドポイント。

次の URLを入力します

POST: http://mock-api-caller.openlegacy.com/api/v1/endpoints/export

2. Bodyへ移動し、 → select row → チェックリスから JSON を選択します。

3. エクスポートしたいエンドポイントIDを次のようにJSONに編集します。

             }
              "endpointsIds": [

                  "endpoint-id"

                 ]

              }

4. ボディにJSONを入力します。

5. 送信します。

これで、エンドポイントの定義をJSONで受け取ることができます。

APIを利用しエンドポイントをエクスポートする場合:

base-url 文字列を API call に追加し、エクスポートするエンドポイントの base-url プロパティを置き換えます:
- 追加する（文字列値が空でも）場合、指定された各エンドポイントの元のbase-url がAPIで指定された新しいbase-url に置き換えられます。
  - 検証: URLには文字のみ有効です
- API callに追加しない場合、どのエンドポイントの元の base-url も変更しません。
- base-urlがHTTPスキーマプレフィックスで指定されている場合（http：//…など）:
  - HTTP スキーマプロパティを新規のURLに適応するように変更します
  - 必要に応じ、ベースURLを変更します

パブリッシュ - エンドポイント

Receives one endpoint’s ID or a set of endpoint IDs and updates the status of the corresponding endpoints to PUBLISH.

次の URLを入力します:

PUT: http://mock-api-caller.openlegacy.com/api/v1/endpoints/bulk/publish

Bodyへ移動し、 → select row → チェックリスから JSON を選択します。
公開したいエンドポイントIDでJSONを編集します。E

                {
                "endpointsIds": [

                  "endpoint-id"

                 ]

              }

3. ボディにJSONを入力します。

4. 送信します。

これでDRAFTからPUBLISHへエンドポイントのステータスを変更できました。

アンパブリッシュ - エンドポイント

1つのエンドポイントのIDまたはエンドポイントIDのセットを受信し、対応するエンドポイントのステータスをDRAFTに更新します。

次の URLを入力します:

PUT: http://mock-api-caller.openlegacy.com/api/v1/endpoints/bulk/unpublish

2. ボディへ移動 → select row → チェックリスからJSON JSONを選択します。

3. アンパブリッシュしたいエンドポイントのID IDで、次のJSONを編集します。

             {

                "endpointsIds": [

                  "endpoint-id"

                 ]

              }

4. JSONをボディに挿入します。

5. 送信します。

エンドポイントのステータスが PUBLISH から DRAFTへ変更されました。

編集 - エンドポイント

エンドポイント定義を受け取り、指定されたエンドポイント定義で対応するエンドポイントを更新します。

次の URLを入力します:
PUT: http://mock-api-caller.openlegacy.com/api/v1/endpoints/:id
/get エンドポイントを利用し、更新したいエンドポイントのSwagger仕様を取得します。
Params へ移動し、パス変数でIDを定義します。
ヘッダへ移動し、application/json.として、 Acceptを定義します。
エンドポイントの定義スコープをリクエストボディにコピーします。

例:

注意! ここでの画像は、必要なスコープを説明するためだけのものです。特定のJSONは使用しないでください。s

6. フィールドを編集します。

注意! 現在、編集長フィールドのみがサポートされています。

7. 送信します。

エンドポイントの更新に成功しました。

OpenLegacy Japanese Documentation

API Caller RESTful API ドキュメント

Related content