ForHosting KIT · 開発者向けツール

OpenAPIパスパラメーターを記述順に抽出

OpenAPIのパス用テンプレートでは可変部分を波括弧で囲みますが、ドキュメント生成、リクエスト作成、テストデータ作成、コード生成では、その名前を順序付きの一覧として扱う必要があります。この機能はテンプレートを左から右へ走査し、各パスパラメーターを出現位置どおりに返します。対応する相手がない開始または終了の波括弧はエラーになります。ネットワークを使わず決定的に動作するため、同じ入力から常に同じ結果が得られ、ビルドスクリプト、検証工程、エディター、自動API処理に適しています。

● Beta無料・ブラウザ内で実行

無料で実行 API仕様を見る

ご利用方法ウェブAPIメールTelegramアプリ近日

パス用テンプレートを順序付き一覧に変換します

OpenAPIの操作では<code>/users/{id}/posts/{postId}</code>のようなパスを使用できますが、周辺のツールでは<code>id</code>と<code>postId</code>を個別の値として必要とする場合があります。この抽出処理は、テンプレートの最初の文字から最後の文字までを読み取り、パラメーターを同じ順序で返します。リクエスト作成ツール、モックサーバー、ドキュメントの例、テスト生成ツールでは、値をURL内の位置と対応付けることがあるため、順序は重要です。抽出した文字列の並べ替え、重複排除、名前変更、正規化は行いません。同じ名前が2回現れれば、結果にも2回含まれ、入力されたテンプレートを正確に反映します。静的なパス部分は無視されるため、スラッシュ、バージョン表記、記号、波括弧の外側にある通常の文字列が余分な項目になることはありません。波括弧で囲まれた部分がないテンプレートも有効で、空の一覧を返します。処理範囲を明確に限定しているため、隠れた変換を加えず、より大きなOpenAPI処理へ予測可能な中間結果として組み込めます。

後続処理の前に不正な波括弧を検出します

波括弧が1つ欠けるだけでも、後続処理が気付かないまま誤った結果を出す可能性があります。たとえば、生成ツールが残りのパス全体を1つのパラメーターと解釈したり、実際のリクエストには一致しないテンプレートをドキュメント表示ツールが掲載したりすることがあります。そのため、先行する開始記号のない終了波括弧、最後まで閉じられない開始波括弧、現在のパラメーターを閉じる前に現れた2つ目の開始波括弧を拒否します。エラーには波括弧の位置が示されるので、ビルドログや対話型ツールで不正なテンプレートを素早く特定できます。検証は抽出と同じ1回の直線走査中に行われるため、返された一覧と別の解析状態が食い違うことはありません。波括弧が対応しているテンプレートは、名前が重複していても、パラメーターがなくても通常どおり処理されます。この機能が確認するのは波括弧の構造だけです。OpenAPI文書全体、宣言済みパラメーターオブジェクトの存在、チームの命名規則への適合性は検証しません。それらはスキーマまたは仕様の検証で確認してください。

生成、テスト、APIツールで結果を利用します

返される一覧は、小さく再利用しやすい中間値として設計されています。コード生成ツールは操作に宣言されたパスパラメーターと比較でき、テスト作成ツールは名前ごとにデータ項目を作成でき、リクエスト画面はパス順に入力欄を表示できます。リンターで最初に抽出を行い、波括弧の構造が不正なら直ちに停止することで、分かりにくい二次的なエラーも防げます。アルゴリズムは文字を決定的に走査するだけであり、ネットワーク通信、入力の保存、乱数、現在時刻への依存はありません。そのため、継続的インテグレーションで安全に繰り返し実行でき、入力をキーに結果をキャッシュできます。パス用テンプレートを<code>text</code>フィールドで送信し、<code>parameters</code>から順序付き一覧を取得してください。API実行は1リクエストにつき$0.002で、ブラウザー版はローカルで実行できます。この機能は1つのテンプレートから名前を抽出するものであり、サーバー変数の解決、値の代入、URL部分のエンコード、YAMLまたはJSON形式のOpenAPIファイル全体の解析は行いません。

活用例

操作の宣言を確認します

抽出した名前とOpenAPIで宣言されたパスパラメーターを比較し、不足または余分な宣言を検出します。

リクエストフォームを作成します

変数がパス用テンプレートに現れる順序と同じ並びで入力欄を生成します。

APIテストを生成します

テスト値をリクエストへ代入する前に、パス変数を順序付きのテストデータ項目へ変換します。

よくある質問

この機能は何を返しますか？

波括弧で囲まれた各名前を左から右の順に格納したparameters配列を返します。

対応しない波括弧がある場合はどうなりますか？

入力エラーになり、対応しない記号が開始か終了か、およびそのインデックスが示されます。

重複するパラメーター名は削除されますか？

削除されません。出力はテンプレート内の各出現を順番どおりに表すため、重複した名前も残ります。

OpenAPI文書全体を検証しますか？

検証しません。1つのパス用テンプレートと波括弧だけを調べ、YAML、JSON、操作、パラメーター宣言は解析しません。

APIリクエストの料金はいくらですか？

APIリクエスト1回の料金は$0.002です。ブラウザー版ではテンプレートをサーバーへ送らずに実行できます。

開発者向け — APIアクセス

このページの機能はすべてAPIからも利用できます。自社システムに組み込みたいチーム向けのセクションです。それ以外の方は上のツールをそのままお使いください。

エンドポイント

POSThttps://api.kit.forhosting.com/dev/openapi-path-params-extract

Bearerトークンで認証し、POST1回でタスクをキューに登録します。結果はWebhookまたは署名付きリンクで受け取れます。

お使いのスタックから呼び出す

curl -X POST https://api.kit.forhosting.com/dev/openapi-path-params-extract \
  -H "Authorization: Bearer $KIT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"/users/{id}/posts/{postId}"}'

const res = await fetch("https://api.kit.forhosting.com/dev/openapi-path-params-extract", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.KIT_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "text": "/users/{id}/posts/{postId}"
  })
});
const { task_id } = await res.json();

import os, requests

res = requests.post(
    "https://api.kit.forhosting.com/dev/openapi-path-params-extract",
    headers={"Authorization": f"Bearer {os.environ['KIT_KEY']}"},
    json={
    "text": "/users/{id}/posts/{postId}"
},
)
task_id = res.json()["task_id"]

<?php
$res = file_get_contents("https://api.kit.forhosting.com/dev/openapi-path-params-extract", false, stream_context_create([
  "http" => [
    "method"  => "POST",
    "header"  => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
    "content" => '{"text":"/users/{id}/posts/{postId}"}',
  ],
]));
$task = json_decode($res, true);

body := bytes.NewBufferString(`{"text":"/users/{id}/posts/{postId}"}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/dev/openapi-path-params-extract", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)

リクエスト例

{
  "text": "/users/{id}/posts/{postId}"
}

レスポンス例

{
  "task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
  "type": "dev.openapi_path_params_extract",
  "status": "queued",
  "_links": {
    "result": "/tasks/tsk_…/result"
  }
}

非同期APIです。task_idは即時に返ります。ポーリングは1秒あたり1リクエストまでです。

料金

1リクエストあたり$0.002

単価はすべて公開しています。トークン換算や独自クレジットはありません。失敗したタスクは課金されません。

エラー

HTTP	コード	意味
`401`	`unauthorized`	APIキーが無効か、指定されていません。Authorizationヘッダーを確認してください。
`402`	`insufficient_balance`	残高が不足しています。チャージ後に再度お試しください。
`404`	`unknown_type`	指定されたタスクタイプは存在しません。タイプ名を確認してください。
`429`	`rate_limited`	リクエストが多すぎます。しばらく待ってから再度お試しください。

KITの完全なドキュメントを見る →