5. 作成したAPIの利用について¶

5.1. 利用方法¶

• リクエストヘッダ Content-Type

  メッセージボディにオブジェクトを含める際に指定します。

  JSONの場合は、 application/json 、XMLの場合は、 application/xml と指定します。

• リクエストヘッダ Accept

  戻り情報のフォーマットを指定します。

  JSONの場合は、 application/json 、XMLの場合は、 application/xml と指定します。

  404などのエラー時は指定した形式となる保証はありません。

{
  "error": false,
  "data": {
    "id": 1,
    "name": "Dog",
    "sold": false,
    "attribute": {
      "breed": "golden"
    }
  }
}

{
  "error": true,
  "errorMessage": "[E.IWP.WEBAPIMAKER.CONVERTER.10001] JSON文字列からの変換に失敗しました。 json:434343"
}

コラム

値がnullであるプロパティはJSON、XML共に出力されません。

レスポンスされる HTTP ステータスの種類

200 OK	Accept ヘッダで指定された MIME タイプで処理結果を返却します。
400 Bad Request	リクエストの内容が不正です。 Content-Type が application/json だが JSON 文字列でない 等が考えられます。
401 Unauthorized	未認証状態で、認可が通りません。
403 Forbidden	認証済み状態ですが、認可が通りません。
404 Not Found	URL が定義されていません。
405 Method Not Allowed	そのメソッドではアクセスできません。
406 Not Acceptable	Accept ヘッダに指定されているタイプが全部サポートしておらず、レスポンスを返すことができません。
415 Unsupported Media Type	Content-Type ヘッダに指定されているタイプがサポートしておらず、リクエストを読むことができません。
500 Internal Server Error	内部サーバエラーです。

5.2. セッション管理¶

IMAuthenticationの場合

X-Intramart-Session	動作
keep	セッション管理を何も行いません。
once	セッション管理を何も行いません。
never	Web API実行後にログイン状態である場合、ログアウトを行います。

BasicAuthenticationの場合

X-Intramart-Session	動作
keep	認証済みでない場合は、Web API実行前にログインを行います。実行後は何も行いません。
once	認証済みでない場合は、Web API実行前にログインを行います。Web API実行前に未認証であった場合はログアウトを行います。
never	認証済みでない場合は、Web API実行前にログインを行います。Web API実行後にログイン状態である場合、ログアウトを行います。

OAuthの場合

X-Intramart-Session	動作
keep	認証済みでない場合は、Web API実行前にログインを行います。実行後は何も行いません。
once	認証済みでない場合は、Web API実行前にログインを行います。Web API実行前に未認証であった場合はログアウトを行います。
never	認証済みでない場合は、Web API実行前にログインを行います。Web API実行前に未認証であった場合はログアウトを行います。

5.3. API仕様を参照する¶

• http://<HOST>:<PORT>/<CONTEXT_PATH>/api-docs/${api-category}

注意

上記のAPI仕様のURLは認可によって閲覧を制限できます。

リソース名は「Swagger specification」です。

認可 については「認可仕様書」を参照してください。

注意

API仕様出力を行えるサービスクラスは、 @IMAuthentication が付与されている物のみです。

@IMAuthentication が付与されておらず、 @OAuth または @BasicAuthentication が付与されているサービスクラスの仕様は出力できません。

5.4. Web上からAPI仕様を参照し実行する¶

• http://<HOST>:<PORT>/<CONTEXT_PATH>/swagger_ui/