7.3. カスタムAPI取得

GET /1/(tenantId)/apigw/apis/(apiName)

カスタムAPIを取得する。

Request Headers:  

• X-Application-Id -- アプリケーションID(必須)
• X-Application-Key -- マスターキー(必須)

Parameters:

• apiName (string) -- API名

Query Parameters:  

• format (string) -- "json" または "text"。デフォルトは "json"

Status Codes:

• 200 OK -- 正常にAPIを取得した
• 401 Unauthorized -- 認証エラー
• 403 Forbidden -- 権限エラー
• 404 Not Found -- APIが存在しない
• 504 Gateway Timeout -- タイムアウトエラー

レスポンス

リクエスト成功時はAPI定義が返却される。

クエリパラメータ format に "text" が指定された場合、登録時の定義テキスト(JSON または YAML) がそのまま返却される(Content-Type は "text/plain")。 "json" を指定した場合は JSON で返却される (Content-Type は "application/json")。

エラー時は JSON 形式でエラー通知される。Content-Type ヘッダは "application/json" となる。