help of api-stub

API疎通モジュールの試作時に

api-stubは開発時のスタブレスポンスの利用を目的としたAPIです。レスポンス内容を Set API でキューイングし、プログラムから Get API にアクセスしてキューの先頭からレスポンスを受け取ることができます。

ログイン不要で、URLに任意のIDをセットすることで専用のキューが利用できます。

なお、IDが他のユーザと重複した場合に影響を防ぐ機能はなく、また、高頻度のアクセスに対してはサービスの提供を保証しません。自己責任での簡易のスタブ利用を対象としていますのでご了承ください。

試してみる

まずはSetAPIでデータを投入してみましょう。IDは"com.{YOUR COMPANY}@{YOUR NAME}"の形式を推奨しますが、6文字以上256文字以内であれば何でも構いません。

POST https://api-stub.hentech.work/set/{YOUR ID}
Body: {"message": "this is test mesage I queued first."}

{
    "id": "{YOUR ID}"
}

POST https://api-stub.hentech.work/set/{YOUR ID}
Body: {"message": "this is test mesage I queued second."}

{
    "id": "{YOUR ID}"
}

リクエストボディに記述したJSON文字列がキューに格納されたかどうかは、 List API で確認できます。

Get https://api-stub.hentech.work/List/{YOUR ID}

{
    "id":"{YOUR ID}",
    "messages":[
        {
            "message":"this is test mesage I queued first."
        },
        {
            "message":"this is test mesage I queued second."
        }
    ]
}

投入したレスポンスを Get API で受け取りましょう。

Get https://api-stub.hentech.work/List/{YOUR ID}

{
    "message":"this is test mesage I queued first."
}

今回は Get API へGETでリクエストしましたが、POST, PUT, DELETEでもGETと同じように動作し、キューからレスポンスを返します。 Clear API で利用後はキューを空にしてください。

PUT https://api-stub.hentech.work/Clear/{YOUR ID}

{
    "id": "{YOUR ID}"
}

各APIの仕様

Set

PATH: /set/{YOUR ID}
Method: POST
Body: 必須、空の場合は空文字として取り扱う。文字列でなければならない。
Response: URLで設定したidをidキーに持つJSON文字列

Get

PATH: /get/{YOUR ID}
Method: GET, POST, PUT, DELETEのいずれか
Body: 使用しない。
Response: Set API によりキューイングされた先頭のメッセージ

List

PATH: /list/{YOUR ID}
Method: Get
Body: 使用しない。
Response: URLで設定したidをidキー、キューのメッセージ配列をmessagesキーに持つJSON配列

Clear

PATH: /clear/{YOUR ID}
Method: PUT
Body: 使用しない。
Response: URLで設定したidをidキー、キューに残っていた件数をdeletesに持つJSON文字列