7.1. カスタムAPI登録¶
-
PUT
/1/
(tenantId)/apigw/apis/
(apiName)¶ カスタムAPIを登録する。
Request Headers: - X-Application-Id -- アプリケーションID(必須)
- X-Application-Key -- マスターキー(必須)
- Content-Type -- application/json, text/plain, text/x-yaml のいずれか
Parameters: - apiName (string) -- API名
Status Codes: - 200 OK -- 正常にAPIを登録した
- 400 Bad Request -- パラメータ/リクエストボディ不正
- 401 Unauthorized -- 認証エラー
- 403 Forbidden -- 権限エラー
- 415 Unsupported Media Type -- Content-Type 不正
- 504 Gateway Timeout -- タイムアウトエラー
リクエストボディ
API定義(Swagger 2.0形式JSONまたはYAML)を指定する。
レスポンス
リクエスト成功時は以下。
{ "result":"ok" }
エラー時は JSON 形式でエラー通知される。Content-Type ヘッダは "application/json" となる。
注意事項
- 指定したapi-nameで、既にAPIが登録されていた場合、上書きする。
- api-nameは任意のパス文字列とし、クライアントが指定する