SwaggerUIで確認できないリクエストがあります。確認する方法はありますか？

エンドポイント作成時に、カスタム処理を利用しGETクエリの内容で処理分岐させる場合、SwaggerUIでは確認できない場合があります。

その場合は、SwaggerUIに表示されているCurlコマンドをコピーし、ターミナルで実行すると確認ができます。

Curlの確認方法

対象のエンドポイントのSwaggerUIを開き、「Curl」に記載されている内容をコピーします。

curl -X 'GET' \
'https://[サイトキー].g.kuroco.app/rcms-api/1/plain-custom-endpoint' \
-H 'accept: */*'

ターミナルを開き、コピーしたURLを貼り付け確認します。 その際に、URL末尾に?クエリキー名=値を指定するとGETクエリを付加できます。

SwaggerUIを利用できない理由

SwaggerUIは、Kurocoが持つOpenAPIの仕様に準拠して画面を生成します。
このため、OpenAPIの定義以外のリクエストをしたい場合はSwaggerUIで確認ができず、Curlを利用し独自にリクエストする必要があります。

例えば、カスタム処理がstatusというGETクエリの内容で処理分岐させる場合、SwaggerUIで確認はできません。
SwaggerUIではstatusパラメータは表示されないためです。

このように、カスタム処理でリクエストのstatusパラメータから処理を分岐した場合はOpenAPIの定義外となります。
そのため、SwaggerUIではカスタム処理が期待するリクエストを発行できません。

SwaggerUIで確認ができない場合、今回のようにCurlにて確認をお願い致します。